Google Cloud Dataproc V1 Client - Class SessionTemplateControllerClient (3.14.0)

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

Service Description: The SessionTemplateController provides methods to manage session templates.

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 \ Dataproc \ V1 \ Client

Methods

__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 `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.

createSessionTemplate

Create a session template synchronously.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::createSessionTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\CreateSessionTemplateRequest` 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\Dataproc\V1\SessionTemplate`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Dataproc\V1\CreateSessionTemplateRequest;
use Google\Cloud\Dataproc\V1\SessionTemplate;

/**
 * @param string $formattedParent     The parent resource where this session template will be created. Please see
 *                                    {@see SessionTemplateControllerClient::locationName()} for help formatting this field.
 * @param string $sessionTemplateName The resource name of the session template.
 */
function create_session_template_sample(
    string $formattedParent,
    string $sessionTemplateName
): void {
    // Create a client.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // Prepare the request message.
    $sessionTemplate = (new SessionTemplate())
        ->setName($sessionTemplateName);
    $request = (new CreateSessionTemplateRequest())
        ->setParent($formattedParent)
        ->setSessionTemplate($sessionTemplate);

    // Call the API and handle any network failures.
    try {
        /** @var SessionTemplate $response */
        $response = $sessionTemplateControllerClient->createSessionTemplate($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
{
    $formattedParent = SessionTemplateControllerClient::locationName('[PROJECT]', '[LOCATION]');
    $sessionTemplateName = '[NAME]';

    create_session_template_sample($formattedParent, $sessionTemplateName);
}

deleteSessionTemplate

Deletes a session template.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::deleteSessionTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\DeleteSessionTemplateRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Dataproc\V1\DeleteSessionTemplateRequest;

/**
 * @param string $formattedName The name of the session template resource to delete. Please see
 *                              {@see SessionTemplateControllerClient::sessionTemplateName()} for help formatting this field.
 */
function delete_session_template_sample(string $formattedName): void
{
    // Create a client.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // Prepare the request message.
    $request = (new DeleteSessionTemplateRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $sessionTemplateControllerClient->deleteSessionTemplate($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = SessionTemplateControllerClient::sessionTemplateName(
        '[PROJECT]',
        '[LOCATION]',
        '[TEMPLATE]'
    );

    delete_session_template_sample($formattedName);
}

getSessionTemplate

Gets the resource representation for a session template.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::getSessionTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\GetSessionTemplateRequest` 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\Dataproc\V1\SessionTemplate`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Dataproc\V1\GetSessionTemplateRequest;
use Google\Cloud\Dataproc\V1\SessionTemplate;

/**
 * @param string $formattedName The name of the session template to retrieve. Please see
 *                              {@see SessionTemplateControllerClient::sessionTemplateName()} for help formatting this field.
 */
function get_session_template_sample(string $formattedName): void
{
    // Create a client.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // Prepare the request message.
    $request = (new GetSessionTemplateRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var SessionTemplate $response */
        $response = $sessionTemplateControllerClient->getSessionTemplate($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 = SessionTemplateControllerClient::sessionTemplateName(
        '[PROJECT]',
        '[LOCATION]',
        '[TEMPLATE]'
    );

    get_session_template_sample($formattedName);
}

listSessionTemplates

Lists session templates.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::listSessionTemplatesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\ListSessionTemplatesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Dataproc\V1\ListSessionTemplatesRequest;
use Google\Cloud\Dataproc\V1\SessionTemplate;

/**
 * @param string $formattedParent The parent that owns this collection of session templates. Please see
 *                                {@see SessionTemplateControllerClient::locationName()} for help formatting this field.
 */
function list_session_templates_sample(string $formattedParent): void
{
    // Create a client.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // Prepare the request message.
    $request = (new ListSessionTemplatesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $sessionTemplateControllerClient->listSessionTemplates($request);

        /** @var SessionTemplate $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 = SessionTemplateControllerClient::locationName('[PROJECT]', '[LOCATION]');

    list_session_templates_sample($formattedParent);
}

updateSessionTemplate

Updates the session template synchronously.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::updateSessionTemplateAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\UpdateSessionTemplateRequest` 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\Dataproc\V1\SessionTemplate`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Dataproc\V1\SessionTemplate;
use Google\Cloud\Dataproc\V1\UpdateSessionTemplateRequest;

/**
 * @param string $sessionTemplateName The resource name of the session template.
 */
function update_session_template_sample(string $sessionTemplateName): void
{
    // Create a client.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // Prepare the request message.
    $sessionTemplate = (new SessionTemplate())
        ->setName($sessionTemplateName);
    $request = (new UpdateSessionTemplateRequest())
        ->setSessionTemplate($sessionTemplate);

    // Call the API and handle any network failures.
    try {
        /** @var SessionTemplate $response */
        $response = $sessionTemplateControllerClient->updateSessionTemplate($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
{
    $sessionTemplateName = '[NAME]';

    update_session_template_sample($sessionTemplateName);
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @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.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $sessionTemplateControllerClient->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);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @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.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // 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 = $sessionTemplateControllerClient->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 resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\SessionTemplateControllerClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @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.
    $sessionTemplateControllerClient = new SessionTemplateControllerClient();

    // 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 = $sessionTemplateControllerClient->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);
}

createSessionTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\CreateSessionTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSessionTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\DeleteSessionTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSessionTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\GetSessionTemplateRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSessionTemplatesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\ListSessionTemplatesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateSessionTemplateAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dataproc\V1\UpdateSessionTemplateRequest`
`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`

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`

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::serviceName

Formats a string containing the fully-qualified path to represent a service resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted service resource.

static::sessionTemplateName

Formats a string containing the fully-qualified path to represent a session_template resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`template`	`string`

Returns
Type	Description
`string`	The formatted session_template 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

location: projects/{project}/locations/{location}
service: projects/{project}/locations/{location}/services/{service}
sessionTemplate: projects/{project}/locations/{location}/sessionTemplates/{template}

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.