Package com.google.cloud.apihub.v1
Interface DeploymentOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Deployment,Deployment.Builder
@Generated
public interface DeploymentOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsAttributes(String key) Optional.getApiVersions(int index) Output only.com.google.protobuf.ByteStringgetApiVersionsBytes(int index) Output only.intOutput only.Output only.Deprecated.intOptional.Optional.getAttributesOrDefault(String key, AttributeValues defaultValue) Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Required.Required.Optional.com.google.protobuf.ByteStringOptional.Required.com.google.protobuf.ByteStringRequired.Optional.Optional.getEndpoints(int index) Required.com.google.protobuf.ByteStringgetEndpointsBytes(int index) Required.intRequired.Required.Optional.Optional.Optional.Optional.getName()Identifier.com.google.protobuf.ByteStringIdentifier.Required.com.google.protobuf.ByteStringRequired.getSlo()Optional.Optional.Optional.com.google.protobuf.ByteStringOptional.getSourceMetadata(int index) Output only.intOutput only.Output only.getSourceMetadataOrBuilder(int index) Output only.List<? extends SourceMetadataOrBuilder>Output only.Optional.com.google.protobuf.ByteStringOptional.Optional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanRequired.booleanOptional.booleanOptional.booleanOptional.booleanhasSlo()Optional.booleanOptional.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 deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The bytes for name.
-
getDisplayName
String getDisplayName()Required. The display name of the deployment.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()Required. The display name of the deployment.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The bytes for displayName.
-
getDescription
String getDescription()Optional. The description of the deployment.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Optional. The description of the deployment.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for description.
-
hasDocumentation
boolean hasDocumentation()Optional. The documentation of the deployment.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the documentation field is set.
-
getDocumentation
Documentation getDocumentation()Optional. The documentation of the deployment.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The documentation.
-
getDocumentationOrBuilder
DocumentationOrBuilder getDocumentationOrBuilder()Optional. The documentation of the deployment.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL]; -
hasDeploymentType
boolean hasDeploymentType()Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` 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 deployment_type = 5 [(.google.api.field_behavior) = REQUIRED];- Returns:
- Whether the deploymentType field is set.
-
getDeploymentType
AttributeValues getDeploymentType()Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` 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 deployment_type = 5 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The deploymentType.
-
getDeploymentTypeOrBuilder
AttributeValuesOrBuilder getDeploymentTypeOrBuilder()Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` 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 deployment_type = 5 [(.google.api.field_behavior) = REQUIRED]; -
getResourceUri
String getResourceUri()Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`.string resource_uri = 6 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The resourceUri.
-
getResourceUriBytes
com.google.protobuf.ByteString getResourceUriBytes()Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`.string resource_uri = 6 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The bytes for resourceUri.
-
getEndpointsList
Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];- Returns:
- A list containing the endpoints.
-
getEndpointsCount
int getEndpointsCount()Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The count of endpoints.
-
getEndpoints
Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];- Parameters:
index- The index of the element to return.- Returns:
- The endpoints at the given index.
-
getEndpointsBytes
com.google.protobuf.ByteString getEndpointsBytes(int index) Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
repeated string endpoints = 7 [(.google.api.field_behavior) = REQUIRED];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the endpoints at the given index.
-
getApiVersionsList
Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- A list containing the apiVersions.
-
getApiVersionsCount
int getApiVersionsCount()Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The count of apiVersions.
-
getApiVersions
Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
index- The index of the element to return.- Returns:
- The apiVersions at the given index.
-
getApiVersionsBytes
com.google.protobuf.ByteString getApiVersionsBytes(int index) Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
repeated string api_versions = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the apiVersions at the given index.
-
hasCreateTime
boolean hasCreateTime()Output only. The time at which the deployment was created.
.google.protobuf.Timestamp create_time = 9 [(.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 deployment was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time at which the deployment was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
boolean hasUpdateTime()Output only. The time at which the deployment was last updated.
.google.protobuf.Timestamp update_time = 10 [(.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 deployment was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time at which the deployment was last updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasSlo
boolean hasSlo()Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` 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 slo = 11 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the slo field is set.
-
getSlo
AttributeValues getSlo()Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` 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 slo = 11 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The slo.
-
getSloOrBuilder
AttributeValuesOrBuilder getSloOrBuilder()Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` 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 slo = 11 [(.google.api.field_behavior) = OPTIONAL]; -
hasEnvironment
boolean hasEnvironment()Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` 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 environment = 12 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the environment field is set.
-
getEnvironment
AttributeValues getEnvironment()Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` 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 environment = 12 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The environment.
-
getEnvironmentOrBuilder
AttributeValuesOrBuilder getEnvironmentOrBuilder()Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` 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 environment = 12 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributesCount
int getAttributesCount()Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL]; -
containsAttributes
Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributes
Deprecated.UsegetAttributesMap()instead. -
getAttributesMap
Map<String,AttributeValues> getAttributesMap()Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributesOrDefault
Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL]; -
getAttributesOrThrow
Optional. The list of user defined attributes associated with the deployment 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 = 13 [(.google.api.field_behavior) = OPTIONAL]; -
getSourceMetadataList
List<SourceMetadata> getSourceMetadataList()Output only. The list of sources and metadata from the sources of the deployment.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadata
Output only. The list of sources and metadata from the sources of the deployment.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataCount
int getSourceMetadataCount()Output only. The list of sources and metadata from the sources of the deployment.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataOrBuilderList
List<? extends SourceMetadataOrBuilder> getSourceMetadataOrBuilderList()Output only. The list of sources and metadata from the sources of the deployment.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getSourceMetadataOrBuilder
Output only. The list of sources and metadata from the sources of the deployment.
repeated .google.cloud.apihub.v1.SourceMetadata source_metadata = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasManagementUrl
boolean hasManagementUrl()Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL..google.cloud.apihub.v1.AttributeValues management_url = 15 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the managementUrl field is set.
-
getManagementUrl
AttributeValues getManagementUrl()Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL..google.cloud.apihub.v1.AttributeValues management_url = 15 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The managementUrl.
-
getManagementUrlOrBuilder
AttributeValuesOrBuilder getManagementUrlOrBuilder()Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL..google.cloud.apihub.v1.AttributeValues management_url = 15 [(.google.api.field_behavior) = OPTIONAL]; -
hasSourceUri
boolean hasSourceUri()Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory..google.cloud.apihub.v1.AttributeValues source_uri = 16 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the sourceUri field is set.
-
getSourceUri
AttributeValues getSourceUri()Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory..google.cloud.apihub.v1.AttributeValues source_uri = 16 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The sourceUri.
-
getSourceUriOrBuilder
AttributeValuesOrBuilder getSourceUriOrBuilder()Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory..google.cloud.apihub.v1.AttributeValues source_uri = 16 [(.google.api.field_behavior) = OPTIONAL]; -
getSourceProject
String getSourceProject()Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.
string source_project = 17 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The sourceProject.
-
getSourceProjectBytes
com.google.protobuf.ByteString getSourceProjectBytes()Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.
string source_project = 17 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for sourceProject.
-
getSourceEnvironment
String getSourceEnvironment()Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.
string source_environment = 18 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The sourceEnvironment.
-
getSourceEnvironmentBytes
com.google.protobuf.ByteString getSourceEnvironmentBytes()Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.
string source_environment = 18 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for sourceEnvironment.
-