Interface Attribute.AllowedValueOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Attribute.AllowedValue, Attribute.AllowedValue.Builder
Enclosing class:
Attribute

public static interface Attribute.AllowedValueOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Optional.
    com.google.protobuf.ByteString
    Optional.
    Required.
    com.google.protobuf.ByteString
    Required.
    Required.
    com.google.protobuf.ByteString
    Required.
    boolean
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getId

      String 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]-/.
       
      string id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The id.
    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       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]-/.
       
      string id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for id.
    • getDisplayName

      String getDisplayName()
       Required. The display name of the allowed value.
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.
    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the allowed value.
       
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.
    • getDescription

      String getDescription()
       Optional. The detailed description of the allowed value.
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The detailed description of the allowed value.
       
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.
    • getImmutable

      boolean 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.
       
      bool immutable = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The immutable.