public final class Deployment extends GeneratedMessageV3 implements DeploymentOrBuilder
Details of the deployment where APIs are hosted.
A deployment could represent an Apigee proxy, API gateway, other Google Cloud
services or non-Google Cloud services as well. A deployment entity is a root
level entity in the API hub and exists independent of any API.
Protobuf type google.cloud.apihub.v1.Deployment
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
API_VERSIONS_FIELD_NUMBER
public static final int API_VERSIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEPLOYMENT_TYPE_FIELD_NUMBER
public static final int DEPLOYMENT_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENDPOINTS_FIELD_NUMBER
public static final int ENDPOINTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENVIRONMENT_FIELD_NUMBER
public static final int ENVIRONMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCE_URI_FIELD_NUMBER
public static final int RESOURCE_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SLO_FIELD_NUMBER
public static final int SLO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Deployment getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Deployment.Builder newBuilder()
newBuilder(Deployment prototype)
public static Deployment.Builder newBuilder(Deployment prototype)
public static Deployment parseDelimitedFrom(InputStream input)
public static Deployment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Deployment parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Deployment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Deployment parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Deployment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Deployment parseFrom(CodedInputStream input)
public static Deployment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Deployment parseFrom(InputStream input)
public static Deployment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Deployment parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Deployment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Deployment> parser()
Methods
containsAttributes(String key)
public boolean containsAttributes(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getApiVersions(int index)
public String getApiVersions(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];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The apiVersions at the given index.
|
getApiVersionsBytes(int index)
public 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];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the apiVersions at the given index.
|
getApiVersionsCount()
public 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 |
| Type |
Description |
int |
The count of apiVersions.
|
getApiVersionsList()
public ProtocolStringList 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];
getAttributes() (deprecated)
public Map<String,AttributeValues> getAttributes()
getAttributesCount()
public 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];
| Returns |
| Type |
Description |
int |
|
getAttributesMap()
public 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(String key, AttributeValues defaultValue)
public AttributeValues getAttributesOrDefault(String key, AttributeValues defaultValue)
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(String key)
public AttributeValues getAttributesOrThrow(String key)
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];
| Parameter |
| Name |
Description |
key |
String
|
getCreateTime()
public 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 |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the deployment was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Deployment getDefaultInstanceForType()
getDeploymentType()
public 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];
getDeploymentTypeOrBuilder()
public 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];
getDescription()
public String getDescription()
Optional. The description of the deployment.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. The description of the deployment.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
public String getDisplayName()
Required. The display name of the deployment.
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 deployment.
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 deployment.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()
Optional. The documentation of the deployment.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
getEndpoints(int index)
public String getEndpoints(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];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The endpoints at the given index.
|
getEndpointsBytes(int index)
public 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];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the endpoints at the given index.
|
getEndpointsCount()
public 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 |
| Type |
Description |
int |
The count of endpoints.
|
getEndpointsList()
public ProtocolStringList 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];
getEnvironment()
public 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];
getEnvironmentOrBuilder()
public 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];
getName()
Identifier. The name of the deployment.
Format:
projects/{project}/locations/{location}/deployments/{deployment}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The name of the deployment.
Format:
projects/{project}/locations/{location}/deployments/{deployment}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Deployment> getParserForType()
Overrides
getResourceUri()
public String getResourceUri()
Required. A URI to the runtime resource. This URI can be used to manage the
resource. For example, if the runtime resource is of type APIGEE_PROXY,
then this field will contain the URI to the management UI of the proxy.
string resource_uri = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The resourceUri.
|
getResourceUriBytes()
public ByteString getResourceUriBytes()
Required. A URI to the runtime resource. This URI can be used to manage the
resource. For example, if the runtime resource is of type APIGEE_PROXY,
then this field will contain the URI to the management UI of the proxy.
string resource_uri = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for resourceUri.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSlo()
public 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];
getSloOrBuilder()
public 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];
getUpdateTime()
public 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 |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public 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];
hasCreateTime()
public 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 |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasDeploymentType()
public 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 |
| Type |
Description |
boolean |
Whether the deploymentType field is set.
|
hasDocumentation()
public boolean hasDocumentation()
Optional. The documentation of the deployment.
.google.cloud.apihub.v1.Documentation documentation = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the documentation field is set.
|
hasEnvironment()
public 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 |
| Type |
Description |
boolean |
Whether the environment field is set.
|
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 |
| Type |
Description |
boolean |
Whether the slo field is set.
|
hasUpdateTime()
public 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 |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Deployment.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Deployment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Deployment.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
