public static final class Version.Builder extends GeneratedMessageV3.Builder<Version.Builder> implements VersionOrBuilderRepresents a version of the API resource in API hub. This is also referred to as the API version.
Protobuf type google.cloud.apihub.v1.Version
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Version.BuilderImplements
VersionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllApiOperations(Iterable<String> values)
public Version.Builder addAllApiOperations(Iterable<String> values) Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The apiOperations to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addAllDefinitions(Iterable<String> values)
public Version.Builder addAllDefinitions(Iterable<String> values) Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The definitions to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addAllDeployments(Iterable<String> values)
public Version.Builder addAllDeployments(Iterable<String> values) Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The deployments to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addAllSpecs(Iterable<String> values)
public Version.Builder addAllSpecs(Iterable<String> values) Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The specs to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addApiOperations(String value)
public Version.Builder addApiOperations(String value) Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe apiOperations to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addApiOperationsBytes(ByteString value)
public Version.Builder addApiOperationsBytes(ByteString value) Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the apiOperations to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addDefinitions(String value)
public Version.Builder addDefinitions(String value) Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe definitions to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addDefinitionsBytes(ByteString value)
public Version.Builder addDefinitionsBytes(ByteString value) Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the definitions to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addDeployments(String value)
public Version.Builder addDeployments(String value) Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe deployments to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addDeploymentsBytes(ByteString value)
public Version.Builder addDeploymentsBytes(ByteString value) Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the deployments to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Version.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
addSpecs(String value)
public Version.Builder addSpecs(String value) Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe specs to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
addSpecsBytes(ByteString value)
public Version.Builder addSpecsBytes(ByteString value) Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the specs to add. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
build()
public Version build()| Returns | |
|---|---|
| Type | Description |
Version |
|
buildPartial()
public Version buildPartial()| Returns | |
|---|---|
| Type | Description |
Version |
|
clear()
public Version.Builder clear()| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearAccreditation()
public Version.Builder clearAccreditation() Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearApiOperations()
public Version.Builder clearApiOperations() Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearAttributes()
public Version.Builder clearAttributes()| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearCompliance()
public Version.Builder clearCompliance() Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearCreateTime()
public Version.Builder clearCreateTime()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearDefinitions()
public Version.Builder clearDefinitions() Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearDeployments()
public Version.Builder clearDeployments() Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearDescription()
public Version.Builder clearDescription()Optional. The description of the version.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearDisplayName()
public Version.Builder clearDisplayName()Required. The display name of the version.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearDocumentation()
public Version.Builder clearDocumentation()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Version.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearLifecycle()
public Version.Builder clearLifecycle() Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearName()
public Version.Builder clearName()Identifier. The name of the version.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Version.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clearSelectedDeployment()
public Version.Builder clearSelectedDeployment() Optional. The selected deployment for a Version resource.
This can be used when special handling is needed on client side for a
particular deployment linked to the version.
Format is
projects/{project}/locations/{location}/deployments/{deployment}
string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearSpecs()
public Version.Builder clearSpecs() Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
clearUpdateTime()
public Version.Builder clearUpdateTime()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
clone()
public Version.Builder clone()| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
containsAttributes(String key)
public boolean containsAttributes(String key) Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAccreditation()
public AttributeValues getAccreditation() Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValues |
The accreditation. |
getAccreditationBuilder()
public AttributeValues.Builder getAccreditationBuilder() Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValues.Builder |
|
getAccreditationOrBuilder()
public AttributeValuesOrBuilder getAccreditationOrBuilder() Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValuesOrBuilder |
|
getApiOperations(int index)
public String getApiOperations(int index) Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The apiOperations at the given index. |
getApiOperationsBytes(int index)
public ByteString getApiOperationsBytes(int index) Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the apiOperations at the given index. |
getApiOperationsCount()
public int getApiOperationsCount() Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of apiOperations. |
getApiOperationsList()
public ProtocolStringList getApiOperationsList() Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the apiOperations. |
getAttributes() (deprecated)
public Map<String,AttributeValues> getAttributes()Use #getAttributesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,AttributeValues> |
|
getAttributesCount()
public int getAttributesCount() Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAttributesMap()
public Map<String,AttributeValues> getAttributesMap() Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,AttributeValues> |
|
getAttributesOrDefault(String key, AttributeValues defaultValue)
public AttributeValues getAttributesOrDefault(String key, AttributeValues defaultValue) Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
AttributeValues |
|
getAttributesOrThrow(String key)
public AttributeValues getAttributesOrThrow(String key) Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
AttributeValues |
|
getCompliance()
public AttributeValues getCompliance() Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValues |
The compliance. |
getComplianceBuilder()
public AttributeValues.Builder getComplianceBuilder() Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValues.Builder |
|
getComplianceOrBuilder()
public AttributeValuesOrBuilder getComplianceOrBuilder() Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValuesOrBuilder |
|
getCreateTime()
public Timestamp getCreateTime()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public Version getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Version |
|
getDefinitions(int index)
public String getDefinitions(int index) Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The definitions at the given index. |
getDefinitionsBytes(int index)
public ByteString getDefinitionsBytes(int index) Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the definitions at the given index. |
getDefinitionsCount()
public int getDefinitionsCount() Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of definitions. |
getDefinitionsList()
public ProtocolStringList getDefinitionsList() Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the definitions. |
getDeployments(int index)
public String getDeployments(int index) Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The deployments at the given index. |
getDeploymentsBytes(int index)
public ByteString getDeploymentsBytes(int index) Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the deployments at the given index. |
getDeploymentsCount()
public int getDeploymentsCount() Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of deployments. |
getDeploymentsList()
public ProtocolStringList getDeploymentsList() Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the deployments. |
getDescription()
public String getDescription()Optional. The description of the version.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. The description of the version.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Required. The display name of the version.
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 version.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getDocumentation()
public Documentation getDocumentation()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Documentation |
The documentation. |
getDocumentationBuilder()
public Documentation.Builder getDocumentationBuilder()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Documentation.Builder |
|
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DocumentationOrBuilder |
|
getLifecycle()
public AttributeValues getLifecycle() Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValues |
The lifecycle. |
getLifecycleBuilder()
public AttributeValues.Builder getLifecycleBuilder() Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValues.Builder |
|
getLifecycleOrBuilder()
public AttributeValuesOrBuilder getLifecycleOrBuilder() Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AttributeValuesOrBuilder |
|
getMutableAttributes() (deprecated)
public Map<String,AttributeValues> getMutableAttributes()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,AttributeValues> |
|
getName()
public String getName()Identifier. The name of the version.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Identifier. The name of the version.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getSelectedDeployment()
public String getSelectedDeployment() Optional. The selected deployment for a Version resource.
This can be used when special handling is needed on client side for a
particular deployment linked to the version.
Format is
projects/{project}/locations/{location}/deployments/{deployment}
string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The selectedDeployment. |
getSelectedDeploymentBytes()
public ByteString getSelectedDeploymentBytes() Optional. The selected deployment for a Version resource.
This can be used when special handling is needed on client side for a
particular deployment linked to the version.
Format is
projects/{project}/locations/{location}/deployments/{deployment}
string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for selectedDeployment. |
getSpecs(int index)
public String getSpecs(int index) Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The specs at the given index. |
getSpecsBytes(int index)
public ByteString getSpecsBytes(int index) Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the specs at the given index. |
getSpecsCount()
public int getSpecsCount() Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of specs. |
getSpecsList()
public ProtocolStringList getSpecsList() Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the specs. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasAccreditation()
public boolean hasAccreditation() Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the accreditation field is set. |
hasCompliance()
public boolean hasCompliance() Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the compliance field is set. |
hasCreateTime()
public boolean hasCreateTime()Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDocumentation()
public boolean hasDocumentation()Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the documentation field is set. |
hasLifecycle()
public boolean hasLifecycle() Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lifecycle field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAccreditation(AttributeValues value)
public Version.Builder mergeAccreditation(AttributeValues value) Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeCompliance(AttributeValues value)
public Version.Builder mergeCompliance(AttributeValues value) Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeCreateTime(Timestamp value)
public Version.Builder mergeCreateTime(Timestamp value)Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeDocumentation(Documentation value)
public Version.Builder mergeDocumentation(Documentation value)Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Documentation |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeFrom(Version other)
public Version.Builder mergeFrom(Version other)| Parameter | |
|---|---|
| Name | Description |
other |
Version |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Version.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Version.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeLifecycle(AttributeValues value)
public Version.Builder mergeLifecycle(AttributeValues value) Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Version.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
mergeUpdateTime(Timestamp value)
public Version.Builder mergeUpdateTime(Timestamp value)Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
putAllAttributes(Map<String,AttributeValues> values)
public Version.Builder putAllAttributes(Map<String,AttributeValues> values) Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,AttributeValues> |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
putAttributes(String key, AttributeValues value)
public Version.Builder putAttributes(String key, AttributeValues value) Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
putAttributesBuilderIfAbsent(String key)
public AttributeValues.Builder putAttributesBuilderIfAbsent(String key) Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
AttributeValues.Builder |
|
removeAttributes(String key)
public Version.Builder removeAttributes(String key) Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
map<string, .google.cloud.apihub.v1.AttributeValues> attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setAccreditation(AttributeValues value)
public Version.Builder setAccreditation(AttributeValues value) Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setAccreditation(AttributeValues.Builder builderForValue)
public Version.Builder setAccreditation(AttributeValues.Builder builderForValue) Optional. The accreditations associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-accreditation
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues accreditation = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AttributeValues.Builder |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setApiOperations(int index, String value)
public Version.Builder setApiOperations(int index, String value) Output only. The operations contained in the API version.
These operations will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
repeated string api_operations = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe apiOperations to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setCompliance(AttributeValues value)
public Version.Builder setCompliance(AttributeValues value) Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setCompliance(AttributeValues.Builder builderForValue)
public Version.Builder setCompliance(AttributeValues.Builder builderForValue) Optional. The compliance associated with the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-compliance
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues compliance = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AttributeValues.Builder |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setCreateTime(Timestamp value)
public Version.Builder setCreateTime(Timestamp value)Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public Version.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The time at which the version was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setDefinitions(int index, String value)
public Version.Builder setDefinitions(int index, String value) Output only. The definitions contained in the API version.
These definitions will be added to the version when a new spec is
added or when an existing spec is updated. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
repeated string definitions = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe definitions to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setDeployments(int index, String value)
public Version.Builder setDeployments(int index, String value) Optional. The deployments linked to this API version.
Note: A particular API version could be deployed to multiple deployments
(for dev deployment, UAT deployment, etc)
Format is
projects/{project}/locations/{location}/deployments/{deployment}
repeated string deployments = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe deployments to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setDescription(String value)
public Version.Builder setDescription(String value)Optional. The description of the version.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Version.Builder setDescriptionBytes(ByteString value)Optional. The description of the version.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setDisplayName(String value)
public Version.Builder setDisplayName(String value)Required. The display name of the version.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Version.Builder setDisplayNameBytes(ByteString value)Required. The display name of the version.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setDocumentation(Documentation value)
public Version.Builder setDocumentation(Documentation value)Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Documentation |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setDocumentation(Documentation.Builder builderForValue)
public Version.Builder setDocumentation(Documentation.Builder builderForValue)Optional. The documentation of the version.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Documentation.Builder |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Version.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setLifecycle(AttributeValues value)
public Version.Builder setLifecycle(AttributeValues value) Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AttributeValues |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setLifecycle(AttributeValues.Builder builderForValue)
public Version.Builder setLifecycle(AttributeValues.Builder builderForValue) Optional. The lifecycle of the API version.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-lifecycle
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
.google.cloud.apihub.v1.AttributeValues lifecycle = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AttributeValues.Builder |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setName(String value)
public Version.Builder setName(String value)Identifier. The name of the version.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Version.Builder setNameBytes(ByteString value)Identifier. The name of the version.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Version.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setSelectedDeployment(String value)
public Version.Builder setSelectedDeployment(String value) Optional. The selected deployment for a Version resource.
This can be used when special handling is needed on client side for a
particular deployment linked to the version.
Format is
projects/{project}/locations/{location}/deployments/{deployment}
string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe selectedDeployment to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setSelectedDeploymentBytes(ByteString value)
public Version.Builder setSelectedDeploymentBytes(ByteString value) Optional. The selected deployment for a Version resource.
This can be used when special handling is needed on client side for a
particular deployment linked to the version.
Format is
projects/{project}/locations/{location}/deployments/{deployment}
string selected_deployment = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for selectedDeployment to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setSpecs(int index, String value)
public Version.Builder setSpecs(int index, String value) Output only. The specs associated with this version.
Note that an API version can be associated with multiple specs.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
repeated string specs = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe specs to set. |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Version.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setUpdateTime(Timestamp value)
public Version.Builder setUpdateTime(Timestamp value)Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Version.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The time at which the version was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Version.Builder |
|