Google Cloud Api Hub V1 Client - Class AllowedValue (0.1.0)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class AllowedValue.

The value that can be assigned to the attribute when the data type is enum.

Generated from protobuf message google.cloud.apihub.v1.Attribute.AllowedValue

Namespace

Google \ Cloud \ ApiHub \ V1 \ Attribute

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ id string

Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

↳ display_name string

Required. The display name of the allowed value.

↳ description string

Optional. The detailed description of the allowed value.

↳ immutable bool

Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.

getId

Required. The ID of the allowed value.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource.
  • If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
Returns
Type Description
string

setId

Required. The ID of the allowed value.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource.
  • If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name of the allowed value.

Returns
Type Description
string

setDisplayName

Required. The display name of the allowed value.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. The detailed description of the allowed value.

Returns
Type Description
string

setDescription

Optional. The detailed description of the allowed value.

Parameter
Name Description
var string
Returns
Type Description
$this

getImmutable

Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.

Returns
Type Description
bool

setImmutable

Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.

Parameter
Name Description
var bool
Returns
Type Description
$this