Google Cloud Api Hub V1 Client - Class Api (0.1.1)

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

An API resource in the API Hub.

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

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The name of the API resource in the API Hub. Format: projects/{project}/locations/{location}/apis/{api}
↳ display_name string

Required. The display name of the API resource.
↳ description string

Optional. The description of the API resource.
↳ documentation Google\Cloud\ApiHub\V1\Documentation

Optional. The documentation for the API resource.
↳ owner Google\Cloud\ApiHub\V1\Owner

Optional. Owner details for the API resource.
↳ versions array

Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}
↳ create_time Google\Protobuf\Timestamp

Output only. The time at which the API resource was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time at which the API resource was last updated.
↳ target_user Google\Cloud\ApiHub\V1\AttributeValues

Optional. The target users for the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
↳ team Google\Cloud\ApiHub\V1\AttributeValues

Optional. The team owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
↳ business_unit Google\Cloud\ApiHub\V1\AttributeValues

Optional. The business unit owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
↳ maturity_level Google\Cloud\ApiHub\V1\AttributeValues

Optional. The maturity level of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
↳ attributes array|Google\Protobuf\Internal\MapField

Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.
↳ api_style Google\Cloud\ApiHub\V1\AttributeValues

Optional. The style of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
↳ selected_version string

Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

getName

Identifier. The name of the API resource in the API Hub.

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

Returns
Type Description
string

setName

Identifier. The name of the API resource in the API Hub.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name of the API resource.

Returns
Type Description
string

setDisplayName

Required. The display name of the API resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. The description of the API resource.

Returns
Type Description
string

setDescription

Optional. The description of the API resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getDocumentation

Optional. The documentation for the API resource.

Returns
Type Description
Google\Cloud\ApiHub\V1\Documentation|null

hasDocumentation

clearDocumentation

setDocumentation

Optional. The documentation for the API resource.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\Documentation
Returns
Type Description
$this

getOwner

Optional. Owner details for the API resource.

Returns
Type Description
Google\Cloud\ApiHub\V1\Owner|null

hasOwner

clearOwner

setOwner

Optional. Owner details for the API resource.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\Owner
Returns
Type Description
$this

getVersions

Output only. The list of versions present in an API resource.

Note: An API resource can be associated with more than 1 version. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setVersions

Output only. The list of versions present in an API resource.

Note: An API resource can be associated with more than 1 version. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

Parameter
Name Description
var string[]
Returns
Type Description
$this

getCreateTime

Output only. The time at which the API resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the API resource was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time at which the API resource was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the API resource was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getTargetUser

Optional. The target users for the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Returns
Type Description
Google\Cloud\ApiHub\V1\AttributeValues|null

hasTargetUser

clearTargetUser

setTargetUser

Optional. The target users for the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\AttributeValues
Returns
Type Description
$this

getTeam

Optional. The team owning the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Returns
Type Description
Google\Cloud\ApiHub\V1\AttributeValues|null

hasTeam

clearTeam

setTeam

Optional. The team owning the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\AttributeValues
Returns
Type Description
$this

getBusinessUnit

Optional. The business unit owning the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Returns
Type Description
Google\Cloud\ApiHub\V1\AttributeValues|null

hasBusinessUnit

clearBusinessUnit

setBusinessUnit

Optional. The business unit owning the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\AttributeValues
Returns
Type Description
$this

getMaturityLevel

Optional. The maturity level of the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Returns
Type Description
Google\Cloud\ApiHub\V1\AttributeValues|null

hasMaturityLevel

clearMaturityLevel

setMaturityLevel

Optional. The maturity level of the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\AttributeValues
Returns
Type Description
$this

getAttributes

Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}.

The value is the attribute values associated with the resource.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAttributes

Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}.

The value is the attribute values associated with the resource.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getApiStyle

Optional. The style of the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Returns
Type Description
Google\Cloud\ApiHub\V1\AttributeValues|null

hasApiStyle

clearApiStyle

setApiStyle

Optional. The style of the API.

This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.

Parameter
Name Description
var Google\Cloud\ApiHub\V1\AttributeValues
Returns
Type Description
$this

getSelectedVersion

Optional. The selected version for an API resource.

This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

Returns
Type Description
string

setSelectedVersion

Optional. The selected version for an API resource.

This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

Parameter
Name Description
var string
Returns
Type Description
$this