Class Attribute.AllowedValue (0.1.0)

public static final class Attribute.AllowedValue extends GeneratedMessageV3 implements Attribute.AllowedValueOrBuilder

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

Protobuf type google.cloud.apihub.v1.Attribute.AllowedValue

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

IMMUTABLE_FIELD_NUMBER

public static final int IMMUTABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Attribute.AllowedValue getDefaultInstance()
Returns
Type Description
Attribute.AllowedValue

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Attribute.AllowedValue.Builder newBuilder()
Returns
Type Description
Attribute.AllowedValue.Builder

newBuilder(Attribute.AllowedValue prototype)

public static Attribute.AllowedValue.Builder newBuilder(Attribute.AllowedValue prototype)
Parameter
Name Description
prototype Attribute.AllowedValue
Returns
Type Description
Attribute.AllowedValue.Builder

parseDelimitedFrom(InputStream input)

public static Attribute.AllowedValue parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Attribute.AllowedValue parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Attribute.AllowedValue parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Attribute.AllowedValue parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Attribute.AllowedValue parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Attribute.AllowedValue parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Attribute.AllowedValue parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Attribute.AllowedValue parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Attribute.AllowedValue parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Attribute.AllowedValue parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Attribute.AllowedValue parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Attribute.AllowedValue parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Attribute.AllowedValue
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Attribute.AllowedValue> parser()
Returns
Type Description
Parser<AllowedValue>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Attribute.AllowedValue getDefaultInstanceForType()
Returns
Type Description
Attribute.AllowedValue

getDescription()

public String getDescription()

Optional. The detailed description of the allowed value.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The detailed description of the allowed value.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. The display name of the allowed value.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the allowed value.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getId()

public 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-/.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The id.

getIdBytes()

public 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-/.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for id.

getImmutable()

public 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
Type Description
boolean

The immutable.

getParserForType()

public Parser<Attribute.AllowedValue> getParserForType()
Returns
Type Description
Parser<AllowedValue>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Attribute.AllowedValue.Builder newBuilderForType()
Returns
Type Description
Attribute.AllowedValue.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Attribute.AllowedValue.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Attribute.AllowedValue.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Attribute.AllowedValue.Builder toBuilder()
Returns
Type Description
Attribute.AllowedValue.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException