Class: Google::Cloud::ApiHub::V1::Attribute::AllowedValue

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/apihub/v1/common_fields.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns Optional. The detailed description of the allowed value.

Returns:

  • (::String) —

    Optional. The detailed description of the allowed value.



599
600
601
602
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 599

class AllowedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Required. The display name of the allowed value.

Returns:

  • (::String) —

    Required. The display name of the allowed value.



599
600
601
602
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 599

class AllowedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ ::String

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



599
600
601
602
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 599

class AllowedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#immutable ⇒ ::Boolean

Returns 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.



599
600
601
602
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 599

class AllowedValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end