Google Cloud Api Hub V1 Client - Class Deployment (0.4.0)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class 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.

Generated from protobuf message google.cloud.apihub.v1.Deployment

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}
↳ display_name string

Required. The display name of the deployment.
↳ description string

Optional. The description of the deployment.
↳ documentation Documentation

Optional. The documentation of the deployment.
↳ deployment_type 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.
↳ resource_uri string

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.
↳ endpoints array

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.
↳ api_versions array

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).
↳ create_time Google\Protobuf\Timestamp

Output only. The time at which the deployment was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time at which the deployment was last updated.
↳ slo 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.
↳ environment 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.
↳ attributes array|Google\Protobuf\Internal\MapField

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.
↳ source_metadata array<SourceMetadata>

Output only. The list of sources and metadata from the sources of the deployment.
↳ management_url AttributeValues

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.
↳ source_uri AttributeValues

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.
↳ source_project string

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.
↳ source_environment string

Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.

getName

Identifier. The name of the deployment.

Format: projects/{project}/locations/{location}/deployments/{deployment}

Returns
Type Description
string

setName

Identifier. The name of the deployment.

Format: projects/{project}/locations/{location}/deployments/{deployment}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name of the deployment.

Returns
Type Description
string

setDisplayName

Required. The display name of the deployment.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. The description of the deployment.

Returns
Type Description
string

setDescription

Optional. The description of the deployment.

Parameter
Name Description
var string
Returns
Type Description
$this

getDocumentation

Optional. The documentation of the deployment.

Returns
Type Description
Documentation|null

hasDocumentation

clearDocumentation

setDocumentation

Optional. The documentation of the deployment.

Parameter
Name Description
var Documentation
Returns
Type Description
$this

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.

Returns
Type Description
AttributeValues|null

hasDeploymentType

clearDeploymentType

setDeploymentType

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.

Parameter
Name Description
var AttributeValues
Returns
Type Description
$this

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.

Returns
Type Description
string

setResourceUri

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEndpoints

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

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).

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setApiVersions

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).

Parameter
Name Description
var string[]
Returns
Type Description
$this

getCreateTime

Output only. The time at which the deployment was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the deployment was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time at which the deployment was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the deployment was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

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.

Returns
Type Description
AttributeValues|null

hasSlo

clearSlo

setSlo

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.

Parameter
Name Description
var AttributeValues
Returns
Type Description
$this

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.

Returns
Type Description
AttributeValues|null

hasEnvironment

clearEnvironment

setEnvironment

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.

Parameter
Name Description
var AttributeValues
Returns
Type Description
$this

getAttributes

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAttributes

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getSourceMetadata

Output only. The list of sources and metadata from the sources of the deployment.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSourceMetadata

Output only. The list of sources and metadata from the sources of the deployment.

Parameter
Name Description
var array<SourceMetadata>
Returns
Type Description
$this

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.

Returns
Type Description
AttributeValues|null

hasManagementUrl

clearManagementUrl

setManagementUrl

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.

Parameter
Name Description
var AttributeValues
Returns
Type Description
$this

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.

Returns
Type Description
AttributeValues|null

hasSourceUri

clearSourceUri

setSourceUri

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.

Parameter
Name Description
var AttributeValues
Returns
Type Description
$this

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.

Returns
Type Description
string

setSourceProject

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceEnvironment

Optional. The environment at source for the deployment.

For example: prod, dev, staging, etc.

Returns
Type Description
string

setSourceEnvironment

Optional. The environment at source for the deployment.

For example: prod, dev, staging, etc.

Parameter
Name Description
var string
Returns
Type Description
$this