Google Cloud Api Hub V1 Client - Class ApiHubInstance (0.2.1)

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

An ApiHubInstance represents the instance resources of the API Hub.

Currently, only one ApiHub instance is allowed for each project.

Generated from protobuf message google.cloud.apihub.v1.ApiHubInstance

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance} .

↳ create_time
Google\Protobuf\Timestamp

Output only. Creation timestamp.

↳ update_time
Google\Protobuf\Timestamp

Output only. Last update timestamp.

↳ state
int

Output only. The current state of the ApiHub instance.

↳ state_message
string

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED .

↳ config
ApiHubInstance\Config

Required. Config of the ApiHub instance.

↳ labels
array| Google\Protobuf\Internal\MapField

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

↳ description
string

Optional. Description of the ApiHub instance.

getName

Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance} .

Returns
Type
Description
string

setName

Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Creation timestamp.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation timestamp.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Last update timestamp.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update timestamp.

Parameter
Name
Description
Returns
Type
Description
$this

getState

Output only. The current state of the ApiHub instance.

Returns
Type
Description
int
Enum of type State .

setState

Output only. The current state of the ApiHub instance.

Parameter
Name
Description
var
int

Enum of type State .

Returns
Type
Description
$this

getStateMessage

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED .

Returns
Type
Description
string

setStateMessage

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getConfig

Required. Config of the ApiHub instance.

Returns
Type
Description

hasConfig

clearConfig

setConfig

Required. Config of the ApiHub instance.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. Instance labels to represent user-provided metadata.

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

Returns
Type
Description

setLabels

Optional. Instance labels to represent user-provided metadata.

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

Parameter
Name
Description
Returns
Type
Description
$this

getDescription

Optional. Description of the ApiHub instance.

Returns
Type
Description
string

setDescription

Optional. Description of the ApiHub instance.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: