Google Cloud Apigee Registry V1 Client - Class ApiVersion (0.5.4)

Version 0.5.4

• 0.5.5 (latest)
• 0.5.4
• 0.4.2
• 0.3.2
• 0.2.7

Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class ApiVersion.

Describes a particular version of an API.

ApiVersions are what consumers actually use.

Generated from protobuf message google.cloud.apigeeregistry.v1.ApiVersion

Namespace

Google \ Cloud \ ApigeeRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
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	Google\Protobuf\Timestamp Output only. Creation timestamp.
↳ update_time	Google\Protobuf\Timestamp Output only. Last update timestamp.
↳ state	string A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED".
↳ 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.

Returns
Type	Description
string

setName

Resource name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Human-meaningful name.

Returns
Type	Description
string

setDisplayName

Human-meaningful name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

A detailed description.

Returns
Type	Description
string

setDescription

A detailed description.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Creation timestamp.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation timestamp.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Last update timestamp.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update timestamp.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getState

A user-definable description of the lifecycle phase of this API version.

Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED".

Returns
Type	Description
string

setState

A user-definable description of the lifecycle phase of this API version.

Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED".

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this