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 \ V1Methods
__construct
Constructor.
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
↳ update_time
↳ 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}
string
setName
Identifier. The name of the operation.
Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
var
string
$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.
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.
var
string
$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.
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.
$this
getCreateTime
Output only. The time at which the operation was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the operation was created.
$this
getUpdateTime
Output only. The time at which the operation was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the operation was last updated.
$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.
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.
$this
getSourceMetadata
Output only. The list of sources and metadata from the sources of the API operation.
setSourceMetadata
Output only. The list of sources and metadata from the sources of the API operation.
$this
