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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ http_operation |
HttpOperation
The HTTP Operation. |
↳ description |
string
Optional. Description of the operation behavior. For OpenAPI spec, this will map to |
↳ documentation |
Documentation
Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to |
↳ deprecated |
bool
Optional. For OpenAPI spec, this will be set if |
getHttpOperation
The HTTP Operation.
| Returns | |
|---|---|
| Type | Description |
HttpOperation|null |
|
hasHttpOperation
setHttpOperation
The HTTP Operation.
| Parameter | |
|---|---|
| Name | Description |
var |
HttpOperation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. 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
Optional. 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
Optional. 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
Optional. 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
Optional. For OpenAPI spec, this will be set if operation.deprecatedis
marked as true in the spec.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDeprecated
Optional. 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 |
|