Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class Api.
A top-level description of an API.
Produced by producers and are commitments to provide services.
Generated from protobuf message google.cloud.apigeeregistry.v1.Api
Namespace
Google \ Cloud \ ApigeeRegistry \ V1Methods
__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.
↳ create_time
↳ update_time
↳ availability
string
A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
↳ recommended_version
string
The recommended version of the API. Format: apis/{api}/versions/{version}
↳ recommended_deployment
string
The recommended deployment of the API. Format: apis/{api}/deployments/{deployment}
↳ 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
getCreateTime
Output only. Creation timestamp.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp.
$this
getUpdateTime
Output only. Last update timestamp.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Last update timestamp.
$this
getAvailability
A user-definable description of the availability of this service.
Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
string
setAvailability
A user-definable description of the availability of this service.
Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
var
string
$this
getRecommendedVersion
The recommended version of the API.
Format: apis/{api}/versions/{version}
string
setRecommendedVersion
The recommended version of the API.
Format: apis/{api}/versions/{version}
var
string
$this
getRecommendedDeployment
The recommended deployment of the API.
Format: apis/{api}/deployments/{deployment}
string
setRecommendedDeployment
The recommended deployment of the API.
Format: apis/{api}/deployments/{deployment}
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
