RuleSetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport]]] = 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>)
Service to manage customer specific RuleSets.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
RuleSetServiceTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
RuleSetServiceClient
RuleSetServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport, typing.Callable[[...], google.cloud.contentwarehouse_v1.services.rule_set_service.transports.base.RuleSetServiceTransport]]] = 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>)
Instantiates the rule set service client.
Parameters | |
---|---|
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 |
Optional[Union[str,RuleSetServiceTransport,Callable[..., RuleSetServiceTransport]]]
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 RuleSetServiceTransport 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 |
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 |
Exceptions | |
---|---|
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.
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_rule_set
create_rule_set(
request: typing.Optional[
typing.Union[
google.cloud.contentwarehouse_v1.types.ruleset_service_request.CreateRuleSetRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
rule_set: typing.Optional[
google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
Creates a ruleset.
# 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 contentwarehouse_v1
def sample_create_rule_set():
# Create a client
client = contentwarehouse_v1.RuleSetServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.CreateRuleSetRequest(
parent="parent_value",
)
# Make the request
response = client.create_rule_set(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contentwarehouse_v1.types.CreateRuleSetRequest, dict]
The request object. Request message for RuleSetService.CreateRuleSet. |
parent |
str
Required. The parent name. Format: projects/{project_number}/locations/{location}. This corresponds to the |
rule_set |
google.cloud.contentwarehouse_v1.types.RuleSet
Required. The rule set to create. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.contentwarehouse_v1.types.RuleSet |
Represents a set of rules from a single customer. |
delete_rule_set
delete_rule_set(
request: typing.Optional[
typing.Union[
google.cloud.contentwarehouse_v1.types.ruleset_service_request.DeleteRuleSetRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a ruleset. Returns NOT_FOUND if the document does not exist.
# 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 contentwarehouse_v1
def sample_delete_rule_set():
# Create a client
client = contentwarehouse_v1.RuleSetServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.DeleteRuleSetRequest(
name="name_value",
)
# Make the request
client.delete_rule_set(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contentwarehouse_v1.types.DeleteRuleSetRequest, dict]
The request object. Request message for RuleSetService.DeleteRuleSet. |
name |
str
Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}. 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. |
document_path
document_path(project: str, location: str, document: str) -> str
Returns a fully-qualified document string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
RuleSetServiceClient |
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.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
RuleSetServiceClient |
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.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
RuleSetServiceClient |
The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
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.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 | |
---|---|
Type | Description |
|
An Operation object. |
get_rule_set
get_rule_set(
request: typing.Optional[
typing.Union[
google.cloud.contentwarehouse_v1.types.ruleset_service_request.GetRuleSetRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.
# 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 contentwarehouse_v1
def sample_get_rule_set():
# Create a client
client = contentwarehouse_v1.RuleSetServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.GetRuleSetRequest(
name="name_value",
)
# Make the request
response = client.get_rule_set(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contentwarehouse_v1.types.GetRuleSetRequest, dict]
The request object. Request message for RuleSetService.GetRuleSet. |
name |
str
Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.contentwarehouse_v1.types.RuleSet |
Represents a set of rules from a single customer. |
list_rule_sets
list_rule_sets(
request: typing.Optional[
typing.Union[
google.cloud.contentwarehouse_v1.types.ruleset_service_request.ListRuleSetsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.contentwarehouse_v1.services.rule_set_service.pagers.ListRuleSetsPager
)
Lists rulesets.
# 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 contentwarehouse_v1
def sample_list_rule_sets():
# Create a client
client = contentwarehouse_v1.RuleSetServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.ListRuleSetsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_rule_sets(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contentwarehouse_v1.types.ListRuleSetsRequest, dict]
The request object. Request message for RuleSetService.ListRuleSets. |
parent |
str
Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.contentwarehouse_v1.services.rule_set_service.pagers.ListRuleSetsPager |
Response message for RuleSetService.ListRuleSets. Iterating over this object will yield results and resolve additional pages automatically. |
location_path
location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_document_path
parse_document_path(path: str) -> typing.Dict[str, str]
Parses a document path into its component segments.
parse_location_path
parse_location_path(path: str) -> typing.Dict[str, str]
Parses a location path into its component segments.
parse_rule_set_path
parse_rule_set_path(path: str) -> typing.Dict[str, str]
Parses a rule_set path into its component segments.
rule_set_path
rule_set_path(project: str, location: str, rule_set: str) -> str
Returns a fully-qualified rule_set string.
update_rule_set
update_rule_set(
request: typing.Optional[
typing.Union[
google.cloud.contentwarehouse_v1.types.ruleset_service_request.UpdateRuleSetRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
rule_set: typing.Optional[
google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.contentwarehouse_v1.types.rule_engine.RuleSet
Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.
# 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 contentwarehouse_v1
def sample_update_rule_set():
# Create a client
client = contentwarehouse_v1.RuleSetServiceClient()
# Initialize request argument(s)
request = contentwarehouse_v1.UpdateRuleSetRequest(
name="name_value",
)
# Make the request
response = client.update_rule_set(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.contentwarehouse_v1.types.UpdateRuleSetRequest, dict]
The request object. Request message for RuleSetService.UpdateRuleSet. |
name |
str
Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}. This corresponds to the |
rule_set |
google.cloud.contentwarehouse_v1.types.RuleSet
Required. The rule set to update. 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. |
Returns | |
---|---|
Type | Description |
google.cloud.contentwarehouse_v1.types.RuleSet |
Represents a set of rules from a single customer. |