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

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

Represents an operation contained in an API version in the API Hub.

An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec.

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

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 operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
`↳ spec`	`string` Output only. The name of the spec from where the operation was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
`↳ details`	`Google\Cloud\ApiHub\V1\OperationDetails` Output only. Operation details.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The time at which the operation was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time at which the operation was last updated.
`↳ attributes`	`array\|Google\Protobuf\Internal\MapField` Optional. The list of user defined attributes associated with the API operation 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.

getName

Identifier. The name of the operation.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

Returns
Type	Description
`string`

setName

Identifier. The name of the operation.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSpec

Output only. The name of the spec from where the operation was parsed.

Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

Returns
Type	Description
`string`

setSpec

Output only. The name of the spec from where the operation was parsed.

Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDetails

Output only. Operation details.

Returns
Type	Description
`Google\Cloud\ApiHub\V1\OperationDetails\|null`

hasDetails

clearDetails

setDetails

Output only. Operation details.

Parameter
Name	Description
`var`	`Google\Cloud\ApiHub\V1\OperationDetails`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time at which the operation was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the operation was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The time at which the operation was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the operation was last updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getAttributes

Optional. The list of user defined attributes associated with the API operation 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

The value is the attribute values associated with the resource.

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

Returns
Type	Description
`$this`