Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class ApiDeployment.
Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time.
Revision identifiers should be updated whenever the served API spec or endpoint address changes.
Generated from protobuf message google.cloud.apigeeregistry.v1.ApiDeployment
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Resource name.
↳ display_name
string
Human-meaningful name.
↳ description
string
A detailed description.
↳ revision_id
string
Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
↳ create_time
Google\Protobuf\Timestamp
Output only. Creation timestamp; when the deployment resource was created.
↳ revision_create_time
Google\Protobuf\Timestamp
Output only. Revision creation timestamp; when the represented revision was created.
↳ revision_update_time
Google\Protobuf\Timestamp
Output only. Last update timestamp: when the represented revision was last modified.
↳ api_spec_revision
string
The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}
↳ endpoint_uri
string
The address where the deployment is serving. Changes to this value will update the revision.
↳ external_channel_uri
string
The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
↳ intended_audience
string
Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
↳ access_guidance
string
Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
↳ labels
array| Google\Protobuf\Internal\MapField
Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf
for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/
and cannot be changed.
↳ annotations
array| Google\Protobuf\Internal\MapField
Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
getName
Resource name.
string
setName
Resource name.
var
string
$this
getDisplayName
Human-meaningful name.
string
setDisplayName
Human-meaningful name.
var
string
$this
getDescription
A detailed description.
string
setDescription
A detailed description.
var
string
$this
getRevisionId
Output only. Immutable. The revision ID of the deployment.
A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
string
setRevisionId
Output only. Immutable. The revision ID of the deployment.
A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
var
string
$this
getCreateTime
Output only. Creation timestamp; when the deployment resource was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp; when the deployment resource was created.
$this
getRevisionCreateTime
Output only. Revision creation timestamp; when the represented revision was created.
hasRevisionCreateTime
clearRevisionCreateTime
setRevisionCreateTime
Output only. Revision creation timestamp; when the represented revision was created.
$this
getRevisionUpdateTime
Output only. Last update timestamp: when the represented revision was last modified.
hasRevisionUpdateTime
clearRevisionUpdateTime
setRevisionUpdateTime
Output only. Last update timestamp: when the represented revision was last modified.
$this
getApiSpecRevision
The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision.
Format: apis/{api}/deployments/{deployment}
string
setApiSpecRevision
The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision.
Format: apis/{api}/deployments/{deployment}
var
string
$this
getEndpointUri
The address where the deployment is serving. Changes to this value will update the revision.
string
setEndpointUri
The address where the deployment is serving. Changes to this value will update the revision.
var
string
$this
getExternalChannelUri
The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
string
setExternalChannelUri
The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
var
string
$this
getIntendedAudience
Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
string
setIntendedAudience
Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
var
string
$this
getAccessGuidance
Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
string
setAccessGuidance
Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
var
string
$this
getLabels
Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf
for more information and examples of labels.
System reserved label keys are prefixed with apigeeregistry.googleapis.com/
and cannot be changed.
setLabels
Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf
for more information and examples of labels.
System reserved label keys are prefixed with apigeeregistry.googleapis.com/
and cannot be changed.
$this
getAnnotations
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
setAnnotations
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
$this
