ControlServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport]] = None, client_options: 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>)
Service for modifying Control.
Inheritance
builtins.object > ControlServiceClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
ControlServiceTransport | The transport used by the client instance. |
Methods
ControlServiceClient
ControlServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.retail_v2alpha.services.control_service.transports.base.ControlServiceTransport]] = None, client_options: 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>)
Instantiates the control service client.
Name | Description |
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 |
Union[str, ControlServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
catalog_path
catalog_path(project: str, location: str, catalog: str)
Returns a fully-qualified catalog string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
control_path
control_path(project: str, location: str, catalog: str, control: str)
Returns a fully-qualified control string.
create_control
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a Control.
If the xref_Control to create already exists, an ALREADY_EXISTS error is returned.
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"
control.search_solution_use_case = "SEARCH_SOLUTION_USE_CASE_BROWSE"
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)
Name | Description |
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: |
control |
google.cloud.retail_v2alpha.types.Control
Required. The Control to create. This corresponds to the |
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 / |
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. |
Type | Description |
google.cloud.retail_v2alpha.types.Control | Configures dynamic serving time metadata that is used to pre and post process search/recommendation model results. |
delete_control
delete_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.DeleteControlRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a Control.
If the xref_Control to delete does not exist, a NOT_FOUND error is returned.
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)
Name | Description |
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: |
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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ControlServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
ControlServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ControlServiceClient | The constructed client. |
get_control
get_control(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.GetControlRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a Control.
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)
Name | Description |
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 delete. Format: |
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. |
Type | Description |
google.cloud.retail_v2alpha.types.Control | Configures dynamic serving time metadata that is used to pre and post process search/recommendation model results. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
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 variabel 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.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
list_controls
list_controls(request: Optional[Union[google.cloud.retail_v2alpha.types.control_service.ListControlsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all Controls linked to this catalog.
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)
Name | Description |
request |
Union[google.cloud.retail_v2alpha.types.ListControlsRequest, dict]
The request object. Request for ListControls method. |
parent |
str
Required. The catalog resource name. Format: |
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. |
Type | Description |
google.cloud.retail_v2alpha.services.control_service.pagers.ListControlsPager | Response for ListControls method. Iterating over this object will yield results and resolve additional pages automatically. |
parse_catalog_path
parse_catalog_path(path: str)
Parses a catalog path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_control_path
parse_control_path(path: str)
Parses a control path into its component segments.
update_control
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a Control.
xref_Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the xref_Control to delete does not exist, a NOT_FOUND error is returned.
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"
control.search_solution_use_case = "SEARCH_SOLUTION_USE_CASE_BROWSE"
request = retail_v2alpha.UpdateControlRequest(
control=control,
)
# Make the request
response = client.update_control(request=request)
# Handle the response
print(response)
Name | Description |
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 |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Indicates which fields in the provided Control to update. The following are NOT supported: - Control.name If not set or empty, all supported fields are updated. This corresponds to the |
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. |
Type | Description |
google.cloud.retail_v2alpha.types.Control | Configures dynamic serving time metadata that is used to pre and post process search/recommendation model results. |