Google Cloud Ai Platform V1 Client - Class SpecialistPoolServiceClient (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SpecialistPoolServiceClient.

Service Description: A service for creating and managing Customer SpecialistPools.

When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $formattedParent = $specialistPoolServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $specialistPool = new SpecialistPool();
    $operationResponse = $specialistPoolServiceClient->createSpecialistPool($formattedParent, $specialistPool);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $specialistPoolServiceClient->createSpecialistPool($formattedParent, $specialistPool);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $specialistPoolServiceClient->resumeOperation($operationName, 'createSpecialistPool');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $specialistPoolServiceClient->close();
}

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.

Methods

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.

specialistPoolName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`specialistPool`	`string`

Returns
Type	Description
`string`	The formatted specialist_pool resource.

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}
specialistPool: projects/{project}/locations/{location}/specialistPools/{specialist_pool}

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.

getOperationsClient

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

Returns
Type	Description
`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
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`

__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 {@see} object or {@see} 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 {@see} .
`↳ 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 {@see} 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 {@see} and {@see} 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.

createSpecialistPool

Creates a SpecialistPool.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $formattedParent = $specialistPoolServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $specialistPool = new SpecialistPool();
    $operationResponse = $specialistPoolServiceClient->createSpecialistPool($formattedParent, $specialistPool);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $specialistPoolServiceClient->createSpecialistPool($formattedParent, $specialistPool);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $specialistPoolServiceClient->resumeOperation($operationName, 'createSpecialistPool');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.
`specialistPool`	`Google\Cloud\AIPlatform\V1\SpecialistPool` Required. The SpecialistPool to create.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteSpecialistPool

Deletes a SpecialistPool as well as all Specialists in the pool.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $formattedName = $specialistPoolServiceClient->specialistPoolName('[PROJECT]', '[LOCATION]', '[SPECIALIST_POOL]');
    $operationResponse = $specialistPoolServiceClient->deleteSpecialistPool($formattedName);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        // operation succeeded and returns no value
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $specialistPoolServiceClient->deleteSpecialistPool($formattedName);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $specialistPoolServiceClient->resumeOperation($operationName, 'deleteSpecialistPool');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        // operation succeeded and returns no value
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`name`	`string` Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
`optionalArgs`	`array` Optional.
`↳ force`	`bool` If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getSpecialistPool

Gets a SpecialistPool.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $formattedName = $specialistPoolServiceClient->specialistPoolName('[PROJECT]', '[LOCATION]', '[SPECIALIST_POOL]');
    $response = $specialistPoolServiceClient->getSpecialistPool($formattedName);
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`name`	`string` Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\SpecialistPool`

listSpecialistPools

Lists SpecialistPools in a Location.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $formattedParent = $specialistPoolServiceClient->locationName('[PROJECT]', '[LOCATION]');
    // Iterate over pages of elements
    $pagedResponse = $specialistPoolServiceClient->listSpecialistPools($formattedParent);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $specialistPoolServiceClient->listSpecialistPools($formattedParent);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`parent`	`string` Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ readMask`	`FieldMask` Mask specifying which fields to read. FieldMask represents a set of
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateSpecialistPool

Updates a SpecialistPool.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $specialistPool = new SpecialistPool();
    $updateMask = new FieldMask();
    $operationResponse = $specialistPoolServiceClient->updateSpecialistPool($specialistPool, $updateMask);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $specialistPoolServiceClient->updateSpecialistPool($specialistPool, $updateMask);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $specialistPoolServiceClient->resumeOperation($operationName, 'updateSpecialistPool');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`specialistPool`	`Google\Cloud\AIPlatform\V1\SpecialistPool` Required. The SpecialistPool which replaces the resource on the server.
`updateMask`	`Google\Protobuf\FieldMask` Required. The update mask applies to the resource.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getLocation

Gets information about a location.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $response = $specialistPoolServiceClient->getLocation();
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Resource name for the location.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

listLocations

Lists information about the supported locations for this service.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    // Iterate over pages of elements
    $pagedResponse = $specialistPoolServiceClient->listLocations();
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $specialistPoolServiceClient->listLocations();
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` The resource that owns the locations collection, if applicable.
`↳ filter`	`string` The standard list filter.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

getIamPolicy

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

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $resource = 'resource';
    $response = $specialistPoolServiceClient->getIamPolicy($resource);
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`optionalArgs`	`array` Optional.
`↳ options`	`GetPolicyOptions` OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

setIamPolicy

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $resource = 'resource';
    $policy = new Policy();
    $response = $specialistPoolServiceClient->setIamPolicy($resource, $policy);
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`Google\Cloud\Iam\V1\Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\Policy`

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.

Sample code:

$specialistPoolServiceClient = new SpecialistPoolServiceClient();
try {
    $resource = 'resource';
    $permissions = [];
    $response = $specialistPoolServiceClient->testIamPermissions($resource, $permissions);
} finally {
    $specialistPoolServiceClient->close();
}

Parameters
Name	Description
`resource`	`string` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	`string[]` 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.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a {@see} object, or an associative array of retry settings parameters. See the documentation on {@see} for example usage.

Returns
Type	Description
`Google\Cloud\Iam\V1\TestIamPermissionsResponse`

Constants

SERVICE_NAME

Value: 'google.cloud.aiplatform.v1.SpecialistPoolService'

The name of the service.

SERVICE_ADDRESS

Value: 'aiplatform.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.