Google Cloud Storage Batch Operations V1 Client - Class DeleteJobRequest (0.1.2)

Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class DeleteJobRequest.

Message for deleting a Job

Generated from protobuf message google.cloud.storagebatchoperations.v1.DeleteJobRequest

Namespace

Google \ Cloud \ StorageBatchOperations \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the job to delete. Format: projects/{project_id}/locations/global/jobs/{job_id} .

↳ request_id string

Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same request_id will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getName

Required. The name of the job to delete.

Format: projects/{project_id}/locations/global/jobs/{job_id} .

Returns
Type Description
string

setName

Required. The name of the job to delete.

Format: projects/{project_id}/locations/global/jobs/{job_id} .

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same request_id will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same request_id will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the job to delete. Format: projects/{project_id}/locations/global/jobs/{job_id} . Please see StorageBatchOperationsClient::jobName() for help formatting this field.

Returns
Type Description
DeleteJobRequest