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

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. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.

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 will be of the format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec} Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
↳ details OperationDetails

Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
↳ 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.
↳ source_metadata array<SourceMetadata>

Output only. The list of sources and metadata from the sources of the API operation.

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 will be of the format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec} Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.

Returns
Type Description
string

setSpec

Output only. The name of the spec will be of the format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec} Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.

Parameter
Name Description
var string
Returns
Type Description
$this

getDetails

Optional. Operation details.

Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.

Returns
Type Description
OperationDetails|null

hasDetails

clearDetails

setDetails

Optional. Operation details.

Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.

Parameter
Name Description
var 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

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.

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

getSourceMetadata

Output only. The list of sources and metadata from the sources of the API operation.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSourceMetadata

Output only. The list of sources and metadata from the sources of the API operation.

Parameter
Name Description
var array<SourceMetadata>
Returns
Type Description
$this