API hub V1 API - Class Google::Cloud::ApiHub::V1::Attribute::AllowedValue (v0.2.0)

Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::Attribute::AllowedValue.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. The detailed description of the allowed value.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The detailed description of the allowed value.
Returns
  • (::String) — Optional. The detailed description of the allowed value.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the allowed value.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the allowed value.
Returns
  • (::String) — Required. The display name of the allowed value.

#id

def id() -> ::String
Returns
  • (::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]-/.

#id=

def id=(value) -> ::String
Parameter
  • value (::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]-/.

Returns
  • (::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]-/.

#immutable

def immutable() -> ::Boolean
Returns
  • (::Boolean) — 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.

#immutable=

def immutable=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.