Reference documentation and code samples for the Google Cloud Run V2 Client class JobsClient.
Service Description: Cloud Run Job Control Plane API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ Run \ V2 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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 |
↳ 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 |
↳ 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. |
createJob
Creates a Job.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::createJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\CreateJobRequest
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 | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\CreateJobRequest;
use Google\Cloud\Run\V2\ExecutionTemplate;
use Google\Cloud\Run\V2\Job;
use Google\Cloud\Run\V2\TaskTemplate;
use Google\Rpc\Status;
/**
* @param string $formattedParent The location and project in which this Job should be created.
* Format: projects/{project}/locations/{location}, where {project} can be
* project id or number. Please see
* {@see JobsClient::locationName()} for help formatting this field.
* @param string $jobId The unique identifier for the Job. The name of the job becomes
* {parent}/jobs/{job_id}.
*/
function create_job_sample(string $formattedParent, string $jobId): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$jobTemplateTemplate = new TaskTemplate();
$jobTemplate = (new ExecutionTemplate())
->setTemplate($jobTemplateTemplate);
$job = (new Job())
->setTemplate($jobTemplate);
$request = (new CreateJobRequest())
->setParent($formattedParent)
->setJob($job)
->setJobId($jobId);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $jobsClient->createJob($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Job $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = JobsClient::locationName('[PROJECT]', '[LOCATION]');
$jobId = '[JOB_ID]';
create_job_sample($formattedParent, $jobId);
}
deleteJob
Deletes a Job.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::deleteJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\DeleteJobRequest;
use Google\Cloud\Run\V2\Job;
use Google\Rpc\Status;
/**
* @param string $formattedName The full name of the Job.
* Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
* can be project id or number. Please see
* {@see JobsClient::jobName()} for help formatting this field.
*/
function delete_job_sample(string $formattedName): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$request = (new DeleteJobRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $jobsClient->deleteJob($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Job $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = JobsClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');
delete_job_sample($formattedName);
}
getIamPolicy
Gets the IAM Access Control policy currently in effect for the given Job.
This result does not include any inherited policies.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
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 | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Run\V2\Client\JobsClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $jobsClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
getJob
Gets information about a Job.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::getJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\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 | |
---|---|
Type | Description |
Google\Cloud\Run\V2\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\GetJobRequest;
use Google\Cloud\Run\V2\Job;
/**
* @param string $formattedName The full name of the Job.
* Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
* can be project id or number. Please see
* {@see JobsClient::jobName()} for help formatting this field.
*/
function get_job_sample(string $formattedName): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$request = (new GetJobRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobsClient->getJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = JobsClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');
get_job_sample($formattedName);
}
listJobs
Lists Jobs. Results are sorted by creation time, descending.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::listJobsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\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 | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\Job;
use Google\Cloud\Run\V2\ListJobsRequest;
/**
* @param string $formattedParent The location and project to list resources on.
* Format: projects/{project}/locations/{location}, where {project} can be
* project id or number. Please see
* {@see JobsClient::locationName()} for help formatting this field.
*/
function list_jobs_sample(string $formattedParent): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$request = (new ListJobsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $jobsClient->listJobs($request);
/** @var Job $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = JobsClient::locationName('[PROJECT]', '[LOCATION]');
list_jobs_sample($formattedParent);
}
runJob
Triggers creation of a new Execution of this Job.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::runJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\RunJobRequest
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 | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\Execution;
use Google\Cloud\Run\V2\RunJobRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The full name of the Job.
* Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
* can be project id or number. Please see
* {@see JobsClient::jobName()} for help formatting this field.
*/
function run_job_sample(string $formattedName): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$request = (new RunJobRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $jobsClient->runJob($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Execution $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = JobsClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');
run_job_sample($formattedName);
}
setIamPolicy
Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
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 | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Run\V2\Client\JobsClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $jobsClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified Project.
There are no permissions required for making this API call.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
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 | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $jobsClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
updateJob
Updates a Job.
The async variant is Google\Cloud\Run\V2\Client\JobsClient::updateJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\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 | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\ExecutionTemplate;
use Google\Cloud\Run\V2\Job;
use Google\Cloud\Run\V2\TaskTemplate;
use Google\Cloud\Run\V2\UpdateJobRequest;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_job_sample(): void
{
// Create a client.
$jobsClient = new JobsClient();
// Prepare the request message.
$jobTemplateTemplate = new TaskTemplate();
$jobTemplate = (new ExecutionTemplate())
->setTemplate($jobTemplateTemplate);
$job = (new Job())
->setTemplate($jobTemplate);
$request = (new UpdateJobRequest())
->setJob($job);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $jobsClient->updateJob($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Job $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
createJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\CreateJobRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\DeleteJobRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\GetJobRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listJobsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\ListJobsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
runJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\RunJobRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Run\V2\UpdateJobRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\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 | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::connectorName
Formats a string containing the fully-qualified path to represent a connector resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
connector |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted connector resource. |
static::cryptoKeyName
Formats a string containing the fully-qualified path to represent a crypto_key resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted crypto_key resource. |
static::executionName
Formats a string containing the fully-qualified path to represent a execution resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
job |
string
|
execution |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted execution resource. |
static::jobName
Formats a string containing the fully-qualified path to represent a job resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
job |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted job resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted location resource. |
static::locationPolicyName
Formats a string containing the fully-qualified path to represent a location_policy resource.
Parameter | |
---|---|
Name | Description |
location |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted location_policy resource. |
static::policyName
Formats a string containing the fully-qualified path to represent a policy resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted policy resource. |
static::projectPolicyName
Formats a string containing the fully-qualified path to represent a project_policy resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_policy resource. |
static::secretName
Formats a string containing the fully-qualified path to represent a secret resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
secret |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted secret resource. |
static::secretVersionName
Formats a string containing the fully-qualified path to represent a secret_version resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
secret |
string
|
version |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted secret_version resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- connector: projects/{project}/locations/{location}/connectors/{connector}
- cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
- execution: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
- job: projects/{project}/locations/{location}/jobs/{job}
- location: projects/{project}/locations/{location}
- locationPolicy: locations/{location}/policy
- policy: projects/{project}/policy
- projectPolicy: projects/{project}/policy
- secret: projects/{project}/secrets/{secret}
- secretVersion: projects/{project}/secrets/{secret}/versions/{version}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array |
An associative array from name component IDs to component values. |