Class RuleServiceAsyncClient (0.1.0)
Stay organized with collections Save and categorize content based on your preferences.

RuleServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.chronicle_v1.services.rule_service.transports.base.RuleServiceTransport, typing.Callable[[...], google.cloud.chronicle_v1.services.rule_service.transports.base.RuleServiceTransport]]] = '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>)

RuleService provides interface for user-created rules.

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
`RuleServiceTransport`	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

RuleServiceAsyncClient

RuleServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.chronicle_v1.services.rule_service.transports.base.RuleServiceTransport, typing.Callable[[...], google.cloud.chronicle_v1.services.rule_service.transports.base.RuleServiceTransport]]] = '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>)

Instantiates the rule service async 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,RuleServiceTransport,Callable[..., RuleServiceTransport]]]` 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 RuleServiceTransport 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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`request`	`.operations_pb2.CancelOperationRequest` The request object. Request message for `CancelOperation` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

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_retrohunt

create_retrohunt(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.CreateRetrohuntRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retrohunt: typing.Optional[google.cloud.chronicle_v1.types.rule.Retrohunt] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Create a Retrohunt.

# 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 chronicle_v1

async def sample_create_retrohunt():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.CreateRetrohuntRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_retrohunt(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.CreateRetrohuntRequest, dict]]` The request object. Request message for CreateRetrohunt method.
`parent`	`str` Required. The parent of retrohunt, which is a rule. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retrohunt`	`Retrohunt` Required. The retrohunt to create. This corresponds to the `retrohunt` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Retrohunt Retrohunt is an execution of a Rule over a time range in the past.

create_rule

create_rule(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.CreateRuleRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    rule: typing.Optional[google.cloud.chronicle_v1.types.rule.Rule] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.rule.Rule

Creates a new Rule.

# 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 chronicle_v1

async def sample_create_rule():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.CreateRuleRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.CreateRuleRequest, dict]]` The request object. Request message for CreateRule method.
`parent`	`str` Required. The parent resource where this rule will be created. Format: `projects/{project}/locations/{location}/instances/{instance}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`rule`	`Rule` Required. The rule to create. This corresponds to the `rule` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.types.Rule`	The Rule resource represents a user-created rule. NEXT TAG: 21

data_access_scope_path

data_access_scope_path(
    project: str, location: str, instance: str, data_access_scope: str
) -> str

Returns a fully-qualified data_access_scope string.

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`request`	`.operations_pb2.DeleteOperationRequest` The request object. Request message for `DeleteOperation` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

delete_rule

delete_rule(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.DeleteRuleRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a Rule.

# 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 chronicle_v1

async def sample_delete_rule():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.DeleteRuleRequest(
        name="name_value",
    )

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.DeleteRuleRequest, dict]]` The request object. Request message for the DeleteRule method.
`name`	`str` Required. The name of the rule to delete. A rule revision timestamp cannot be specified as part of the name, as deleting specific revisions is not supported. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

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
`RuleServiceAsyncClient`	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
`RuleServiceAsyncClient`	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
`RuleServiceAsyncClient`	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,
)

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 `api_endpoint` and `client_cert_source` properties may be used in this method.

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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
`request`	`.operations_pb2.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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`.operations_pb2.Operation`	An `Operation` object.

get_retrohunt

get_retrohunt(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.GetRetrohuntRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.rule.Retrohunt

Get a Retrohunt.

# 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 chronicle_v1

async def sample_get_retrohunt():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.GetRetrohuntRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.GetRetrohuntRequest, dict]]` The request object. Request message for GetRetrohunt method.
`name`	`str` Required. The name of the retrohunt to retrieve. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.types.Retrohunt`	Retrohunt is an execution of a Rule over a time range in the past.

get_rule

get_rule(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.GetRuleRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.rule.Rule

Gets a Rule.

# 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 chronicle_v1

async def sample_get_rule():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.GetRuleRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.GetRuleRequest, dict]]` The request object. Request message for GetRule method.
`name`	`str` Required. The name of the rule to retrieve. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.types.Rule`	The Rule resource represents a user-created rule. NEXT TAG: 21

get_rule_deployment

get_rule_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.rule.GetRuleDeploymentRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.rule.RuleDeployment

Gets a RuleDeployment.

# 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 chronicle_v1

async def sample_get_rule_deployment():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.GetRuleDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.GetRuleDeploymentRequest, dict]]` The request object. Request message for GetRuleDeployment.
`name`	`str` Required. The name of the rule deployment to retrieve. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.types.RuleDeployment`	The RuleDeployment resource represents the deployment state of a Rule.

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.chronicle_v1.services.rule_service.transports.base.RuleServiceTransport
]

Returns an appropriate transport class.

Parameter
Name	Description
`label`	`typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used.

list_operations

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

Lists operations that match the specified filter in the request.

Parameters
Name	Description
`request`	`.operations_pb2.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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`.operations_pb2.ListOperationsResponse`	Response message for `ListOperations` method.

list_retrohunts

list_retrohunts(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.ListRetrohuntsRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.services.rule_service.pagers.ListRetrohuntsAsyncPager

List Retrohunts.

# 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 chronicle_v1

async def sample_list_retrohunts():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListRetrohuntsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.ListRetrohuntsRequest, dict]]` The request object. Request message for ListRetrohunts method.
`parent`	`str` Required. The rule that the retrohunts belong to. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.services.rule_service.pagers.ListRetrohuntsAsyncPager`	Response message for ListRetrohunts method. Iterating over this object will yield results and resolve additional pages automatically.

list_rule_deployments

list_rule_deployments(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.rule.ListRuleDeploymentsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.chronicle_v1.services.rule_service.pagers.ListRuleDeploymentsAsyncPager
)

Lists RuleDeployments across all Rules.

# 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 chronicle_v1

async def sample_list_rule_deployments():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListRuleDeploymentsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.ListRuleDeploymentsRequest, dict]]` The request object. Request message for ListRuleDeployments.
`parent`	`str` Required. The collection of all parents which own all rule deployments. The "-" wildcard token must be used as the rule identifier in the resource path. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/-` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.services.rule_service.pagers.ListRuleDeploymentsAsyncPager`	Response message for ListRuleDeployments. Iterating over this object will yield results and resolve additional pages automatically.

list_rule_revisions

list_rule_revisions(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.rule.ListRuleRevisionsRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.services.rule_service.pagers.ListRuleRevisionsAsyncPager

Lists all revisions of the rule.

# 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 chronicle_v1

async def sample_list_rule_revisions():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListRuleRevisionsRequest(
        name="name_value",
    )

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.ListRuleRevisionsRequest, dict]]` The request object. Request message for ListRuleRevisions method.
`name`	`str` Required. The name of the rule to list revisions for. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.services.rule_service.pagers.ListRuleRevisionsAsyncPager`	Response message for ListRuleRevisions method. Iterating over this object will yield results and resolve additional pages automatically.

list_rules

list_rules(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.ListRulesRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.services.rule_service.pagers.ListRulesAsyncPager

Lists Rules.

# 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 chronicle_v1

async def sample_list_rules():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListRulesRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.ListRulesRequest, dict]]` The request object. Request message for ListRules method.
`parent`	`str` Required. The parent, which owns this collection of rules. Format: `projects/{project}/locations/{location}/instances/{instance}` 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.services.rule_service.pagers.ListRulesAsyncPager`	Response message for ListRules method. Iterating over this object will yield results and resolve additional pages automatically.

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_data_access_scope_path

parse_data_access_scope_path(path: str) -> typing.Dict[str, str]

Parses a data_access_scope path into its component segments.

parse_reference_list_path

parse_reference_list_path(path: str) -> typing.Dict[str, str]

Parses a reference_list path into its component segments.

parse_retrohunt_path

parse_retrohunt_path(path: str) -> typing.Dict[str, str]

Parses a retrohunt path into its component segments.

parse_rule_deployment_path

parse_rule_deployment_path(path: str) -> typing.Dict[str, str]

Parses a rule_deployment path into its component segments.

parse_rule_path

parse_rule_path(path: str) -> typing.Dict[str, str]

Parses a rule path into its component segments.

reference_list_path

reference_list_path(
    project: str, location: str, instance: str, reference_list: str
) -> str

Returns a fully-qualified reference_list string.

retrohunt_path

retrohunt_path(
    project: str, location: str, instance: str, rule: str, retrohunt: str
) -> str

Returns a fully-qualified retrohunt string.

rule_deployment_path

rule_deployment_path(project: str, location: str, instance: str, rule: str) -> str

Returns a fully-qualified rule_deployment string.

rule_path

rule_path(project: str, location: str, instance: str, rule: str) -> str

Returns a fully-qualified rule string.

update_rule

update_rule(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.rule.UpdateRuleRequest, dict]
    ] = None,
    *,
    rule: typing.Optional[google.cloud.chronicle_v1.types.rule.Rule] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.rule.Rule

Updates a Rule.

# 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 chronicle_v1

async def sample_update_rule():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    request = chronicle_v1.UpdateRuleRequest(
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.UpdateRuleRequest, dict]]` The request object. Request message for UpdateRule method.
`rule`	`Rule` Required. The rule to update. The rule's `name` field is used to identify the rule to update. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}` This corresponds to the `rule` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` The list of fields to update. If not included, all fields with a non-empty value will be overwritten. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.types.Rule`	The Rule resource represents a user-created rule. NEXT TAG: 21

update_rule_deployment

update_rule_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.rule.UpdateRuleDeploymentRequest, dict
        ]
    ] = None,
    *,
    rule_deployment: typing.Optional[
        google.cloud.chronicle_v1.types.rule.RuleDeployment
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.rule.RuleDeployment

Updates a RuleDeployment. Failures are not necessarily atomic. If there is a request to update multiple fields, and any update to a single field fails, an error will be returned, but other fields may remain successfully updated.

# 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 chronicle_v1

async def sample_update_rule_deployment():
    # Create a client
    client = chronicle_v1.RuleServiceAsyncClient()

    # Initialize request argument(s)
    rule_deployment = chronicle_v1.RuleDeployment()
    rule_deployment.name = "name_value"

    request = chronicle_v1.UpdateRuleDeploymentRequest(
        rule_deployment=rule_deployment,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.chronicle_v1.types.UpdateRuleDeploymentRequest, dict]]` The request object. Request message for UpdateRuleDeployment.
`rule_deployment`	`RuleDeployment` Required. The rule deployment to update. The rule deployment's `name` field is used to identify the rule deployment to update. Format: `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment` This corresponds to the `rule_deployment` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The list of fields to update. 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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.chronicle_v1.types.RuleDeployment`	The RuleDeployment resource represents the deployment state of a Rule.

Class RuleServiceAsyncClient (0.1.0) Stay organized with collections Save and categorize content based on your preferences.