Google Cloud Api Hub V1 Client - Class OperationDetails (0.1.3)

Version latest

• 0.1.3 (latest)
• 0.1.2

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

The operation details parsed from the spec.

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

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ http_operation	HttpOperation The HTTP Operation.
↳ description	string Output only. Description of the operation behavior. For OpenAPI spec, this will map to operation.description in the spec, in case description is empty, operation.summary will be used.
↳ documentation	Documentation Output only. Additional external documentation for this operation. For OpenAPI spec, this will map to operation.documentation in the spec.
↳ deprecated	bool Output only. For OpenAPI spec, this will be set if operation.deprecatedis marked as true in the spec.

getHttpOperation

The HTTP Operation.

Returns
Type	Description
HttpOperation|null

hasHttpOperation

setHttpOperation

The HTTP Operation.

Parameter
Name	Description
var	HttpOperation

Returns
Type	Description
$this

getDescription

Output only. Description of the operation behavior.

For OpenAPI spec, this will map to operation.description in the spec, in case description is empty, operation.summary will be used.

Returns
Type	Description
string

setDescription

Output only. Description of the operation behavior.

For OpenAPI spec, this will map to operation.description in the spec, in case description is empty, operation.summary will be used.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDocumentation

Output only. Additional external documentation for this operation.

For OpenAPI spec, this will map to operation.documentation in the spec.

Returns
Type	Description
Documentation|null

hasDocumentation

clearDocumentation

setDocumentation

Output only. Additional external documentation for this operation.

For OpenAPI spec, this will map to operation.documentation in the spec.

Parameter
Name	Description
var	Documentation

Returns
Type	Description
$this

getDeprecated

Output only. For OpenAPI spec, this will be set if operation.deprecatedis marked as true in the spec.

Returns
Type	Description
bool

setDeprecated

Output only. For OpenAPI spec, this will be set if operation.deprecatedis marked as true in the spec.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getOperation

Returns
Type	Description
string