Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::Deployment.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#api_versions
def api_versions() -> ::Array<::String>
- (::Array<::String>) — 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).
#attributes
def attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}
-
(::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}) — 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.
#attributes=
def attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}
-
value (::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}) — 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.
-
(::Google::Protobuf::Map{::String => ::Google::Cloud::ApiHub::V1::AttributeValues}) — 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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The time at which the deployment was created.
#deployment_type
def deployment_type() -> ::Google::Cloud::ApiHub::V1::AttributeValues
-
(::Google::Cloud::ApiHub::V1::AttributeValues) — 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.
#deployment_type=
def deployment_type=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
-
value (::Google::Cloud::ApiHub::V1::AttributeValues) — 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) — 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.
#description
def description() -> ::String
- (::String) — Optional. The description of the deployment.
#description=
def description=(value) -> ::String
- value (::String) — Optional. The description of the deployment.
- (::String) — Optional. The description of the deployment.
#display_name
def display_name() -> ::String
- (::String) — Required. The display name of the deployment.
#display_name=
def display_name=(value) -> ::String
- value (::String) — Required. The display name of the deployment.
- (::String) — Required. The display name of the deployment.
#documentation
def documentation() -> ::Google::Cloud::ApiHub::V1::Documentation
- (::Google::Cloud::ApiHub::V1::Documentation) — Optional. The documentation of the deployment.
#documentation=
def documentation=(value) -> ::Google::Cloud::ApiHub::V1::Documentation
- value (::Google::Cloud::ApiHub::V1::Documentation) — Optional. The documentation of the deployment.
- (::Google::Cloud::ApiHub::V1::Documentation) — Optional. The documentation of the deployment.
#endpoints
def endpoints() -> ::Array<::String>
- (::Array<::String>) — 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.
#endpoints=
def endpoints=(value) -> ::Array<::String>
- value (::Array<::String>) — 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.
- (::Array<::String>) — 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.
#environment
def environment() -> ::Google::Cloud::ApiHub::V1::AttributeValues
-
(::Google::Cloud::ApiHub::V1::AttributeValues) — 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.
#environment=
def environment=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
-
value (::Google::Cloud::ApiHub::V1::AttributeValues) — 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) — 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.
#name
def name() -> ::String
-
(::String) — Identifier. The name of the deployment.
Format:
projects/{project}/locations/{location}/deployments/{deployment}
#name=
def name=(value) -> ::String
-
value (::String) — Identifier. The name of the deployment.
Format:
projects/{project}/locations/{location}/deployments/{deployment}
-
(::String) — Identifier. The name of the deployment.
Format:
projects/{project}/locations/{location}/deployments/{deployment}
#resource_uri
def resource_uri() -> ::String
- (::String) — 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.
#resource_uri=
def resource_uri=(value) -> ::String
- value (::String) — 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) — 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.
#slo
def slo() -> ::Google::Cloud::ApiHub::V1::AttributeValues
-
(::Google::Cloud::ApiHub::V1::AttributeValues) — 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.
#slo=
def slo=(value) -> ::Google::Cloud::ApiHub::V1::AttributeValues
-
value (::Google::Cloud::ApiHub::V1::AttributeValues) — 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) — 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The time at which the deployment was last updated.