Google Cloud Apigee Registry V1 Client - Class Api (1.0.0)

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

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

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

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getRecommendedVersion

The recommended version of the API.

Format: apis/{api}/versions/{version}

Returns
Type Description
string

setRecommendedVersion

The recommended version of the API.

Format: apis/{api}/versions/{version}

Parameter
Name Description
var string
Returns
Type Description
$this

getRecommendedDeployment

The recommended deployment of the API.

Format: apis/{api}/deployments/{deployment}

Returns
Type Description
string

setRecommendedDeployment

The recommended deployment of the API.

Format: apis/{api}/deployments/{deployment}

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