As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ControlService¶

class google.cloud.retail_v2alpha.services.control_service.ControlServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Service for modifying Control.

Instantiates the control service async client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,ControlServiceTransport,Callable[..., ControlServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the ControlServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static catalog_path(project: str, location: str, catalog: str) → str¶: Returns a fully-qualified catalog string.

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

static control_path(project: str, location: str, catalog: str, control: str) → str¶: Returns a fully-qualified control string.

async create_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.CreateControlRequest, dict]] = None, *, parent: Optional[str] = None, control: Optional[google.cloud.retail_v2alpha.types.control.Control] = None, control_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.control.Control[source]¶

Creates a Control.

If the [Control][google.cloud.retail.v2alpha.Control] to create already exists, an ALREADY_EXISTS error is returned.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

async def sample_create_control():
    # Create a client
    client = retail_v2alpha.ControlServiceAsyncClient()

    # Initialize request argument(s)
    control = retail_v2alpha.Control()
    control.facet_spec.facet_key.key = "key_value"
    control.display_name = "display_name_value"
    control.solution_types = ['SOLUTION_TYPE_SEARCH']

    request = retail_v2alpha.CreateControlRequest(
        parent="parent_value",
        control=control,
        control_id="control_id_value",
    )

    # Make the request
    response = await client.create_control(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.CreateControlRequest, dict]]) – The request object. Request for CreateControl method.
parent (str) –
Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
control (google.cloud.retail_v2alpha.types.Control) – Required. The Control to create. This corresponds to the control field on the request instance; if request is provided, this should not be set.
control_id (str) –
Required. The ID to use for the Control, which will become the final component of the Control’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

This corresponds to the control_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Configures dynamic metadata that can be linked to a: [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search or recommendation results at serving time.

Return type

google.cloud.retail_v2alpha.types.Control

async delete_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.DeleteControlRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a Control.

If the [Control][google.cloud.retail.v2alpha.Control] to delete does not exist, a NOT_FOUND error is returned.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

async def sample_delete_control():
    # Create a client
    client = retail_v2alpha.ControlServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.DeleteControlRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_control(request=request)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.DeleteControlRequest, dict]]) – The request object. Request for DeleteControl method.
name (str) –
Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ControlServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ControlServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ControlServiceAsyncClient

async get_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.GetControlRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.control.Control[source]¶

Gets a Control.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

async def sample_get_control():
    # Create a client
    client = retail_v2alpha.ControlServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetControlRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_control(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.GetControlRequest, dict]]) – The request object. Request for GetControl method.
name (str) –
Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Configures dynamic metadata that can be linked to a: [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search or recommendation results at serving time.

Return type

google.cloud.retail_v2alpha.types.Control

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_controls(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.ListControlsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsAsyncPager[source]¶

Lists all Controls by their parent [Catalog][google.cloud.retail.v2alpha.Catalog].

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

async def sample_list_controls():
    # Create a client
    client = retail_v2alpha.ControlServiceAsyncClient()

    # Initialize request argument(s)
    request = retail_v2alpha.ListControlsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_controls(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.ListControlsRequest, dict]]) – The request object. Request for ListControls method.
parent (str) –
Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for ListControls method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsAsyncPager

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

static parse_catalog_path(path: str) → Dict[str, str]¶: Parses a catalog path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_control_path(path: str) → Dict[str, str]¶: Parses a control path into its component segments.

property transport: google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: ControlServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.UpdateControlRequest, dict]] = None, *, control: Optional[google.cloud.retail_v2alpha.types.control.Control] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.control.Control[source]¶

Updates a Control.

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

async def sample_update_control():
    # Create a client
    client = retail_v2alpha.ControlServiceAsyncClient()

    # Initialize request argument(s)
    control = retail_v2alpha.Control()
    control.facet_spec.facet_key.key = "key_value"
    control.display_name = "display_name_value"
    control.solution_types = ['SOLUTION_TYPE_SEARCH']

    request = retail_v2alpha.UpdateControlRequest(
        control=control,
    )

    # Make the request
    response = await client.update_control(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.retail_v2alpha.types.UpdateControlRequest, dict]]) – The request object. Request for UpdateControl method.
control (google.cloud.retail_v2alpha.types.Control) – Required. The Control to update. This corresponds to the control field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Indicates which fields in the provided [Control][google.cloud.retail.v2alpha.Control] to update. The following are NOT supported:
- [Control.name][google.cloud.retail.v2alpha.Control.name]
If not set or empty, all supported fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Configures dynamic metadata that can be linked to a: [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search or recommendation results at serving time.

Return type

google.cloud.retail_v2alpha.types.Control

class google.cloud.retail_v2alpha.services.control_service.ControlServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport, typing.Callable[[...], google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Service for modifying Control.

Instantiates the control service client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,ControlServiceTransport,Callable[..., ControlServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the ControlServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static catalog_path(project: str, location: str, catalog: str) → str[source]¶: Returns a fully-qualified catalog string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

static control_path(project: str, location: str, catalog: str, control: str) → str[source]¶: Returns a fully-qualified control string.

create_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.CreateControlRequest, dict]] = None, *, parent: Optional[str] = None, control: Optional[google.cloud.retail_v2alpha.types.control.Control] = None, control_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.control.Control[source]¶

Creates a Control.

If the [Control][google.cloud.retail.v2alpha.Control] to create already exists, an ALREADY_EXISTS error is returned.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

def sample_create_control():
    # Create a client
    client = retail_v2alpha.ControlServiceClient()

    # Initialize request argument(s)
    control = retail_v2alpha.Control()
    control.facet_spec.facet_key.key = "key_value"
    control.display_name = "display_name_value"
    control.solution_types = ['SOLUTION_TYPE_SEARCH']

    request = retail_v2alpha.CreateControlRequest(
        parent="parent_value",
        control=control,
        control_id="control_id_value",
    )

    # Make the request
    response = client.create_control(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.CreateControlRequest, dict]) – The request object. Request for CreateControl method.
parent (str) –
Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
control (google.cloud.retail_v2alpha.types.Control) – Required. The Control to create. This corresponds to the control field on the request instance; if request is provided, this should not be set.
control_id (str) –
Required. The ID to use for the Control, which will become the final component of the Control’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

This corresponds to the control_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Configures dynamic metadata that can be linked to a: [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search or recommendation results at serving time.

Return type

google.cloud.retail_v2alpha.types.Control

delete_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.DeleteControlRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a Control.

If the [Control][google.cloud.retail.v2alpha.Control] to delete does not exist, a NOT_FOUND error is returned.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

def sample_delete_control():
    # Create a client
    client = retail_v2alpha.ControlServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.DeleteControlRequest(
        name="name_value",
    )

    # Make the request
    client.delete_control(request=request)

Parameters

request (Union[google.cloud.retail_v2alpha.types.DeleteControlRequest, dict]) – The request object. Request for DeleteControl method.
name (str) –
Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ControlServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ControlServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ControlServiceClient

get_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.GetControlRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.control.Control[source]¶

Gets a Control.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

def sample_get_control():
    # Create a client
    client = retail_v2alpha.ControlServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.GetControlRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_control(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.GetControlRequest, dict]) – The request object. Request for GetControl method.
name (str) –
Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Configures dynamic metadata that can be linked to a: [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search or recommendation results at serving time.

Return type

google.cloud.retail_v2alpha.types.Control

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

list_controls(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.ListControlsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsPager[source]¶

Lists all Controls by their parent [Catalog][google.cloud.retail.v2alpha.Catalog].

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

def sample_list_controls():
    # Create a client
    client = retail_v2alpha.ControlServiceClient()

    # Initialize request argument(s)
    request = retail_v2alpha.ListControlsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_controls(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.ListControlsRequest, dict]) – The request object. Request for ListControls method.
parent (str) –
Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for ListControls method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsPager

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

static parse_catalog_path(path: str) → Dict[str, str][source]¶: Parses a catalog path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_control_path(path: str) → Dict[str, str][source]¶: Parses a control path into its component segments.

property transport: google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

ControlServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.UpdateControlRequest, dict]] = None, *, control: Optional[google.cloud.retail_v2alpha.types.control.Control] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.retail_v2alpha.types.control.Control[source]¶

Updates a Control.

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import retail_v2alpha

def sample_update_control():
    # Create a client
    client = retail_v2alpha.ControlServiceClient()

    # Initialize request argument(s)
    control = retail_v2alpha.Control()
    control.facet_spec.facet_key.key = "key_value"
    control.display_name = "display_name_value"
    control.solution_types = ['SOLUTION_TYPE_SEARCH']

    request = retail_v2alpha.UpdateControlRequest(
        control=control,
    )

    # Make the request
    response = client.update_control(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.retail_v2alpha.types.UpdateControlRequest, dict]) – The request object. Request for UpdateControl method.
control (google.cloud.retail_v2alpha.types.Control) – Required. The Control to update. This corresponds to the control field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Indicates which fields in the provided [Control][google.cloud.retail.v2alpha.Control] to update. The following are NOT supported:
- [Control.name][google.cloud.retail.v2alpha.Control.name]
If not set or empty, all supported fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Configures dynamic metadata that can be linked to a: [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search or recommendation results at serving time.

Return type

google.cloud.retail_v2alpha.types.Control

class google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsAsyncPager(method: Callable[[...], Awaitable[google.cloud.retail_v2alpha.types.control_service.ListControlsResponse]], request: google.cloud.retail_v2alpha.types.control_service.ListControlsRequest, response: google.cloud.retail_v2alpha.types.control_service.ListControlsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_controls requests.

This class thinly wraps an initial google.cloud.retail_v2alpha.types.ListControlsResponse object, and provides an __aiter__ method to iterate through its controls field.

If there are more pages, the __aiter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual google.cloud.retail_v2alpha.types.ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.retail_v2alpha.types.ListControlsRequest) – The initial request object.
response (google.cloud.retail_v2alpha.types.ListControlsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsPager(method: Callable[[...], google.cloud.retail_v2alpha.types.control_service.ListControlsResponse], request: google.cloud.retail_v2alpha.types.control_service.ListControlsRequest, response: google.cloud.retail_v2alpha.types.control_service.ListControlsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_controls requests.

This class thinly wraps an initial google.cloud.retail_v2alpha.types.ListControlsResponse object, and provides an __iter__ method to iterate through its controls field.

If there are more pages, the __iter__ method will make additional ListControls requests and continue to iterate through the controls field on the corresponding responses.

All the usual google.cloud.retail_v2alpha.types.ListControlsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.retail_v2alpha.types.ListControlsRequest) – The initial request object.
response (google.cloud.retail_v2alpha.types.ListControlsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

ControlService¶

google-cloud-retail

Navigation

Related Topics