Google Cloud Storage Batch Operations V1 Client - Class CreateJobRequest (0.2.1)

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

Message for creating a Job

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

Namespace

Google \ Cloud \ StorageBatchOperations \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Value for parent.
↳ job_id string

Required. The optional job_id for this Job . If not specified, an id is generated. job_id should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123.
↳ job Job

Required. The resource being created
↳ 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).

getParent

Required. Value for parent.

Returns
Type Description
string

setParent

Required. Value for parent.

Parameter
Name Description
var string
Returns
Type Description
$this

getJobId

Required. The optional job_id for this Job . If not specified, an id is generated. job_id should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123.

Returns
Type Description
string

setJobId

Required. The optional job_id for this Job . If not specified, an id is generated. job_id should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123.

Parameter
Name Description
var string
Returns
Type Description
$this

getJob

Required. The resource being created

Returns
Type Description
Job|null

hasJob

clearJob

setJob

Required. The resource being created

Parameter
Name Description
var Job
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

Parameters
Name Description
parent string

Required. Value for parent. Please see StorageBatchOperationsClient::locationName() for help formatting this field.
job Job

Required. The resource being created
jobId string

Required. The optional job_id for this Job . If not specified, an id is generated. job_id should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123.
Returns
Type Description
CreateJobRequest