Google Cloud Container V1 Client - Class CancelOperationRequest (2.2.0)

Reference documentation and code samples for the Google Cloud Container V1 Client class CancelOperationRequest.

CancelOperationRequest cancels a single operation.

Generated from protobuf message google.container.v1.CancelOperationRequest

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ project_id string

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

↳ zone string

Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

↳ operation_id string

Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

↳ name string

The name (project, location, operation id) of the operation to cancel. Specified in the format projects/*/locations/*/operations/*.

getProjectId

Deprecated. The Google Developers Console project ID or project number.

This field has been deprecated and replaced by the name field.

Returns
Type Description
string

setProjectId

Deprecated. The Google Developers Console project ID or project number.

This field has been deprecated and replaced by the name field.

Parameter
Name Description
var string
Returns
Type Description
$this

getZone

Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

Returns
Type Description
string

setZone

Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

Parameter
Name Description
var string
Returns
Type Description
$this

getOperationId

Deprecated. The server-assigned name of the operation.

This field has been deprecated and replaced by the name field.

Returns
Type Description
string

setOperationId

Deprecated. The server-assigned name of the operation.

This field has been deprecated and replaced by the name field.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

The name (project, location, operation id) of the operation to cancel.

Specified in the format projects/*/locations/*/operations/*.

Returns
Type Description
string

setName

The name (project, location, operation id) of the operation to cancel.

Specified in the format projects/*/locations/*/operations/*.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
projectId string

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

operationId string

Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

Returns
Type Description
Google\Cloud\Container\V1\CancelOperationRequest

static::buildFromName

Parameter
Name Description
name string

The name (project, location, operation id) of the operation to cancel. Specified in the format projects/*/locations/*/operations/*.

Returns
Type Description
Google\Cloud\Container\V1\CancelOperationRequest