Google Cloud Ai Platform V1 Client - Class ScheduleServiceClient (0.28.0)

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\AIPlatform\V1\CreateScheduleRequest;
use Google\Cloud\AIPlatform\V1\Schedule;

/**
 * @param string $formattedParent               The resource name of the Location to create the Schedule in.
 *                                              Format: `projects/{project}/locations/{location}`
 *                                              Please see {@see ScheduleServiceClient::locationName()} for help formatting this field.
 * @param string $scheduleDisplayName           User provided name of the Schedule.
 *                                              The name can be up to 128 characters long and can consist of any UTF-8
 *                                              characters.
 * @param int    $scheduleMaxConcurrentRunCount Maximum number of runs that can be started concurrently for this
 *                                              Schedule. This is the limit for starting the scheduled requests and not the
 *                                              execution of the operations/jobs created by the requests (if applicable).
 */
function create_schedule_sample(
    string $formattedParent,
    string $scheduleDisplayName,
    int $scheduleMaxConcurrentRunCount
): void {
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

    // Prepare the request message.
    $schedule = (new Schedule())
        ->setDisplayName($scheduleDisplayName)
        ->setMaxConcurrentRunCount($scheduleMaxConcurrentRunCount);
    $request = (new CreateScheduleRequest())
        ->setParent($formattedParent)
        ->setSchedule($schedule);

    // Call the API and handle any network failures.
    try {
        /** @var Schedule $response */
        $response = $scheduleServiceClient->createSchedule($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 = ScheduleServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $scheduleDisplayName = '[DISPLAY_NAME]';
    $scheduleMaxConcurrentRunCount = 0;

    create_schedule_sample($formattedParent, $scheduleDisplayName, $scheduleMaxConcurrentRunCount);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteScheduleRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Schedule resource to be deleted.
 *                              Format:
 *                              `projects/{project}/locations/{location}/schedules/{schedule}`
 *                              Please see {@see ScheduleServiceClient::scheduleName()} for help formatting this field.
 */
function delete_schedule_sample(string $formattedName): void
{
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $scheduleServiceClient->deleteSchedule($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = ScheduleServiceClient::scheduleName('[PROJECT]', '[LOCATION]', '[SCHEDULE]');

    delete_schedule_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\AIPlatform\V1\GetScheduleRequest;
use Google\Cloud\AIPlatform\V1\Schedule;

/**
 * @param string $formattedName The name of the Schedule resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/schedules/{schedule}`
 *                              Please see {@see ScheduleServiceClient::scheduleName()} for help formatting this field.
 */
function get_schedule_sample(string $formattedName): void
{
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Schedule $response */
        $response = $scheduleServiceClient->getSchedule($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 = ScheduleServiceClient::scheduleName('[PROJECT]', '[LOCATION]', '[SCHEDULE]');

    get_schedule_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\AIPlatform\V1\ListSchedulesRequest;
use Google\Cloud\AIPlatform\V1\Schedule;

/**
 * @param string $formattedParent The resource name of the Location to list the Schedules from.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see ScheduleServiceClient::locationName()} for help formatting this field.
 */
function list_schedules_sample(string $formattedParent): void
{
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

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

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

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

    list_schedules_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\AIPlatform\V1\PauseScheduleRequest;

/**
 * @param string $formattedName The name of the Schedule resource to be paused.
 *                              Format:
 *                              `projects/{project}/locations/{location}/schedules/{schedule}`
 *                              Please see {@see ScheduleServiceClient::scheduleName()} for help formatting this field.
 */
function pause_schedule_sample(string $formattedName): void
{
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $scheduleServiceClient->pauseSchedule($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 = ScheduleServiceClient::scheduleName('[PROJECT]', '[LOCATION]', '[SCHEDULE]');

    pause_schedule_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\AIPlatform\V1\ResumeScheduleRequest;

/**
 * @param string $formattedName The name of the Schedule resource to be resumed.
 *                              Format:
 *                              `projects/{project}/locations/{location}/schedules/{schedule}`
 *                              Please see {@see ScheduleServiceClient::scheduleName()} for help formatting this field.
 */
function resume_schedule_sample(string $formattedName): void
{
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $scheduleServiceClient->resumeSchedule($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 = ScheduleServiceClient::scheduleName('[PROJECT]', '[LOCATION]', '[SCHEDULE]');

    resume_schedule_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\AIPlatform\V1\Schedule;
use Google\Cloud\AIPlatform\V1\UpdateScheduleRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $scheduleDisplayName           User provided name of the Schedule.
 *                                              The name can be up to 128 characters long and can consist of any UTF-8
 *                                              characters.
 * @param int    $scheduleMaxConcurrentRunCount Maximum number of runs that can be started concurrently for this
 *                                              Schedule. This is the limit for starting the scheduled requests and not the
 *                                              execution of the operations/jobs created by the requests (if applicable).
 */
function update_schedule_sample(
    string $scheduleDisplayName,
    int $scheduleMaxConcurrentRunCount
): void {
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

    // Prepare the request message.
    $schedule = (new Schedule())
        ->setDisplayName($scheduleDisplayName)
        ->setMaxConcurrentRunCount($scheduleMaxConcurrentRunCount);
    $updateMask = new FieldMask();
    $request = (new UpdateScheduleRequest())
        ->setSchedule($schedule)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Schedule $response */
        $response = $scheduleServiceClient->updateSchedule($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
{
    $scheduleDisplayName = '[DISPLAY_NAME]';
    $scheduleMaxConcurrentRunCount = 0;

    update_schedule_sample($scheduleDisplayName, $scheduleMaxConcurrentRunCount);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $scheduleServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $scheduleServiceClient = new ScheduleServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $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());
    }
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
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.
    $scheduleServiceClient = new ScheduleServiceClient();

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

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

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
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.
    $scheduleServiceClient = new ScheduleServiceClient();

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

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\ScheduleServiceClient;
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.
    $scheduleServiceClient = new ScheduleServiceClient();

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