Resource: 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.
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "documentation": { object ( |
Fields | |
---|---|
name |
Identifier. The name of the deployment. Format: |
displayName |
Required. The display name of the deployment. |
description |
Optional. The description of the deployment. |
documentation |
Optional. The documentation of the deployment. |
deploymentType |
Required. The type of deployment. This maps to the following system defined attribute: |
resourceUri |
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. |
endpoints[] |
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. |
apiVersions[] |
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). |
createTime |
Output only. The time at which the deployment was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time at which the deployment was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
slo |
Optional. The SLO for this deployment. This maps to the following system defined attribute: |
environment |
Optional. The environment mapping to this deployment. This maps to the following system defined attribute: |
attributes |
Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: An object containing a list of |
Methods |
|
---|---|
|
Create a deployment resource in the API hub. |
|
Delete a deployment resource in the API hub. |
|
Get details about a deployment and the API versions linked to it. |
|
List deployment resources in the API hub. |
|
Update a deployment resource in the API hub. |