Package com.google.cloud.apihub.v1
Interface AttributeOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Attribute,Attribute.Builder
@Generated
public interface AttributeOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetAllowedValues(int index) Optional.intOptional.Optional.getAllowedValuesOrBuilder(int index) Optional.List<? extends Attribute.AllowedValueOrBuilder>Optional.intOptional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Required.intRequired.Output only.intOutput only.Optional.com.google.protobuf.ByteStringOptional.Required.com.google.protobuf.ByteStringRequired.booleanOutput only.getName()Identifier.com.google.protobuf.ByteStringIdentifier.getScope()Required.intRequired.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The bytes for name.
-
getDisplayName
String getDisplayName()Required. The display name of the attribute.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()Required. The display name of the attribute.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The bytes for displayName.
-
getDescription
String getDescription()Optional. The description of the attribute.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Optional. The description of the attribute.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for description.
-
getDefinitionTypeValue
int getDefinitionTypeValue()Output only. The definition type of the attribute.
.google.cloud.apihub.v1.Attribute.DefinitionType definition_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The enum numeric value on the wire for definitionType.
-
getDefinitionType
Attribute.DefinitionType getDefinitionType()Output only. The definition type of the attribute.
.google.cloud.apihub.v1.Attribute.DefinitionType definition_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The definitionType.
-
getScopeValue
int getScopeValue()Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
.google.cloud.apihub.v1.Attribute.Scope scope = 5 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The enum numeric value on the wire for scope.
-
getScope
Attribute.Scope getScope()Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
.google.cloud.apihub.v1.Attribute.Scope scope = 5 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The scope.
-
getDataTypeValue
int getDataTypeValue()Required. The type of the data of the attribute.
.google.cloud.apihub.v1.Attribute.DataType data_type = 6 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The enum numeric value on the wire for dataType.
-
getDataType
Attribute.DataType getDataType()Required. The type of the data of the attribute.
.google.cloud.apihub.v1.Attribute.DataType data_type = 6 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The dataType.
-
getAllowedValuesList
List<Attribute.AllowedValue> getAllowedValuesList()Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
repeated .google.cloud.apihub.v1.Attribute.AllowedValue allowed_values = 7 [(.google.api.field_behavior) = OPTIONAL]; -
getAllowedValues
Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
repeated .google.cloud.apihub.v1.Attribute.AllowedValue allowed_values = 7 [(.google.api.field_behavior) = OPTIONAL]; -
getAllowedValuesCount
int getAllowedValuesCount()Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
repeated .google.cloud.apihub.v1.Attribute.AllowedValue allowed_values = 7 [(.google.api.field_behavior) = OPTIONAL]; -
getAllowedValuesOrBuilderList
List<? extends Attribute.AllowedValueOrBuilder> getAllowedValuesOrBuilderList()Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
repeated .google.cloud.apihub.v1.Attribute.AllowedValue allowed_values = 7 [(.google.api.field_behavior) = OPTIONAL]; -
getAllowedValuesOrBuilder
Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
repeated .google.cloud.apihub.v1.Attribute.AllowedValue allowed_values = 7 [(.google.api.field_behavior) = OPTIONAL]; -
getCardinality
int getCardinality()Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
int32 cardinality = 8 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The cardinality.
-
getMandatory
boolean getMandatory()Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
bool mandatory = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The mandatory.
-
hasCreateTime
boolean hasCreateTime()Output only. The time at which the attribute was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. The time at which the attribute was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time at which the attribute was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
boolean hasUpdateTime()Output only. The time at which the attribute was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()Output only. The time at which the attribute was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time at which the attribute was last updated.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
-