Google Cloud Dataproc V1 Client - Class JobControllerClient (3.8.1)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class JobControllerClient.

Service Description: The JobController provides methods to manage jobs.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Dataproc \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

cancelJob

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::cancelJobAsync() .

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\CancelJobRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\Job

deleteJob

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::deleteJobAsync() .

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\DeleteJobRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getJob

Gets the resource representation for a job in a project.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::getJobAsync() .

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\GetJobRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\Job

listJobs

Lists regions/{region}/jobs in a project.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::listJobsAsync() .

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\ListJobsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse

submitJob

Submits a job to a cluster.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::submitJobAsync() .

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\SubmitJobRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\Job

submitJobAsOperation

Submits job to a cluster.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::submitJobAsOperationAsync() .

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\SubmitJobRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse

updateJob

Updates a job in a project.

The async variant is Google\Cloud\Dataproc\V1\Client\BaseClient\self::updateJobAsync() .

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\UpdateJobRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\Job

cancelJobAsync

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\CancelJobRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteJobAsync

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\DeleteJobRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getJobAsync

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\GetJobRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listJobsAsync

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\ListJobsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

submitJobAsync

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\SubmitJobRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

submitJobAsOperationAsync

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\SubmitJobRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateJobAsync

Parameters
NameDescription
request Google\Cloud\Dataproc\V1\UpdateJobRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
TypeDescription
Google\ApiCore\LongRunning\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
NameDescription
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse