Google Cloud Retail V2 Client - Class ControlServiceClient (1.3.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class ControlServiceClient.

Service Description: Service for modifying Control.

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

Namespace

Google \ Cloud \ Retail \ V2 \ 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.

createControl

Creates a Control.

If the Control to create already exists, an ALREADY_EXISTS error is returned.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::createControlAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\CreateControlRequest` 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\Retail\V2\Control`

deleteControl

Deletes a Control.

If the Control to delete does not exist, a NOT_FOUND error is returned.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::deleteControlAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\DeleteControlRequest` 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.

getControl

Gets a Control.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::getControlAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetControlRequest` 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\Retail\V2\Control`

listControls

Lists all Controls by their parent Catalog.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::listControlsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ListControlsRequest` 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`

updateControl

Updates a Control.

Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.

The async variant is Google\Cloud\Retail\V2\Client\BaseClient\self::updateControlAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateControlRequest` 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\Retail\V2\Control`

createControlAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\CreateControlRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteControlAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\DeleteControlRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getControlAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\GetControlRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listControlsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\ListControlsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateControlAsync

Parameters
Name	Description
`request`	`Google\Cloud\Retail\V2\UpdateControlRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::catalogName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`

Returns
Type	Description
`string`	The formatted catalog resource.

static::controlName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`catalog`	`string`
`control`	`string`

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

catalog: projects/{project}/locations/{location}/catalogs/{catalog}
control: projects/{project}/locations/{location}/catalogs/{catalog}/controls/{control}

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.