Google Cloud Api Gateway V1 Client - Class Api (1.0.5)

Reference documentation and code samples for the Google Cloud Api Gateway V1 Client class Api.

An API that can be served by one or more Gateways.

Generated from protobuf message google.cloud.apigateway.v1.Api

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

↳ create_time Google\Protobuf\Timestamp

Output only. Created time.

↳ update_time Google\Protobuf\Timestamp

Output only. Updated time.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

↳ display_name string

Optional. Display name.

↳ managed_service string

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

↳ state int

Output only. State of the API.

getName

Output only. Resource name of the API.

Format: projects/{project}/locations/global/apis/{api}

Returns
TypeDescription
string

setName

Output only. Resource name of the API.

Format: projects/{project}/locations/global/apis/{api}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Created time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Created time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Updated time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Updated time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

Optional. Resource labels to represent user-provided metadata.

Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. Resource labels to represent user-provided metadata.

Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getDisplayName

Optional. Display name.

Returns
TypeDescription
string

setDisplayName

Optional. Display name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getManagedService

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

Returns
TypeDescription
string

setManagedService

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. State of the API.

Returns
TypeDescription
int

setState

Output only. State of the API.

Parameter
NameDescription
var int
Returns
TypeDescription
$this