hush-hush

CreateObjectRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CreateObjectRequest Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR  : mixed = null

Properties

$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)

Methods

__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getDescription()  : string|null
Gets description
getKeepReadableCopy()  : bool|null
Gets keep_readable_copy
getModelName()  : string
The original name of the model.
getSlug()  : string
Gets slug
getTags()  : array<string|int, string>|null
Gets tags
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUsedBy()  : array<string|int, string>|null
Gets used_by
getValue()  : string
Gets value
isNullable()  : bool
Checks if a property is nullable
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
jsonSerialize()  : mixed
Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed|null
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
openAPIFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
setDescription()  : self
Sets description
setKeepReadableCopy()  : self
Sets keep_readable_copy
setSlug()  : self
Sets slug
setTags()  : self
Sets tags
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUsedBy()  : self
Sets used_by
setValue()  : self
Sets value
toHeaderValue()  : string
Gets a header-safe presentation of the object
valid()  : bool
Validate all the properties in the model return true if all passed
openAPINullables()  : array<string|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['slug' => 'slug', 'value' => 'value', 'used_by' => 'used_by', 'tags' => 'tags', 'description' => 'description', 'keep_readable_copy' => 'keep_readable_copy']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['slug' => 'getSlug', 'value' => 'getValue', 'used_by' => 'getUsedBy', 'tags' => 'getTags', 'description' => 'getDescription', 'keep_readable_copy' => 'getKeepReadableCopy']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['slug' => null, 'value' => 'byte', 'used_by' => null, 'tags' => null, 'description' => null, 'keep_readable_copy' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CreateObjectRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['slug' => false, 'value' => false, 'used_by' => false, 'tags' => false, 'description' => false, 'keep_readable_copy' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, bool> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $openAPITypes = ['slug' => 'string', 'value' => 'string', 'used_by' => 'string[]', 'tags' => 'string[]', 'description' => 'string', 'keep_readable_copy' => 'bool']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['slug' => 'setSlug', 'value' => 'setValue', 'used_by' => 'setUsedBy', 'tags' => 'setTags', 'description' => 'setDescription', 'keep_readable_copy' => 'setKeepReadableCopy']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|null $data = null ]) : mixed
Parameters
$data : array<string|int, mixed>|null = null

Associated array of property values initializing the model

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDescription()

Gets description

public getDescription() : string|null
Return values
string|null

getKeepReadableCopy()

Gets keep_readable_copy

public getKeepReadableCopy() : bool|null
Return values
bool|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getTags()

Gets tags

public getTags() : array<string|int, string>|null
Return values
array<string|int, string>|null

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUsedBy()

Gets used_by

public getUsedBy() : array<string|int, string>|null
Return values
array<string|int, string>|null

isNullable()

Checks if a property is nullable

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int|string $offset) : bool
Parameters
$offset : int|string

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int|string $offset) : mixed|null
Parameters
$offset : int|string

Offset

Attributes
#[ReturnTypeWillChange]
Return values
mixed|null

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

offsetUnset()

Unsets offset.

public offsetUnset(int|string $offset) : void
Parameters
$offset : int|string

Offset

openAPIFormats()

Array of property to format mappings. Used for (de)serialization

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

openAPITypes()

Array of property to type mappings. Used for (de)serialization

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

setDescription()

Sets description

public setDescription(string|null $description) : self
Parameters
$description : string|null

A free-text label set at creation, for a reader who only knows the slug. Fixed at creation - there is no way to change it later.

Return values
self

setKeepReadableCopy()

Sets keep_readable_copy

public setKeepReadableCopy(bool|null $keep_readable_copy) : self
Parameters
$keep_readable_copy : bool|null

Requests that the owner's own escrowed identity public key be included as an additional decrypt recipient, alongside whatever consumer recipients the client already resolved (specs/secret-objects/spec.md's "Opt-in owner-recipient inclusion at create time" requirement). Omitting this field (the default) means the owner is not added as a recipient - this service never makes ownership imply decrypt access on its own. This is a client-side sealing instruction, not something this service enforces or verifies: it never decrypts, and never adds a recipient to value itself - the caller has to add the owner's public key (GET /auth/identity) to its own recipient list before sealing. A create or update response echoes back exactly what that same request asked for; it isn't persisted, so a later fetch never carries this field.

Return values
self

setSlug()

Sets slug

public setSlug(string $slug) : self
Parameters
$slug : string

A caller-chosen, unique identifier for an object - what every documented request path (URL, CLI, API) addresses it by. Letters of either case, digits, _ and -, starting with a letter or digit; names are case-sensitive, so Api_Token and api_token are two secrets. Create and rename follow the same rule. The object's internal id is a separate, opaque value never exposed to or accepted from a caller (specs/secret-objects/spec.md's "Internal id decoupled from user-facing slug" requirement).

Return values
self

setTags()

Sets tags

public setTags(array<string|int, string>|null $tags) : self
Parameters
$tags : array<string|int, string>|null

Labels for grouping and filtering objects (GET /objects?tag=). Free-form, 1 to 32 characters from a-z 0-9 . _ / -, at most 10 per object. Uppercase is converted to lowercase and duplicates are dropped. Metadata only - never part of the sealed value. A response always carries the array, empty when the object has none.

Return values
self

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

setUsedBy()

Sets used_by

public setUsedBy(array<string|int, string>|null $used_by) : self
Parameters
$used_by : array<string|int, string>|null

The consumers (repos or hosts) recorded as depending on this object. Set at creation, and replaceable later via UpdateObjectRequest's own used_by field - a plain value update that omits it leaves the list as it was. A consumer named more than once is recorded once.

Return values
self

setValue()

Sets value

public setValue(string $value) : self
Parameters
$value : string

The sealed (encrypted) value, base64-encoded. It has to be a well-formed age file naming at least one recipient; the service reads only its header, never the payload. At most 1 MiB once decoded.

Return values
self

toHeaderValue()

Gets a header-safe presentation of the object

public toHeaderValue() : string
Return values
string

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

openAPINullables()

Array of nullable properties

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool>

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
On this page

Search results