Class FindingsRefinementServiceClient (0.6.2)

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

FindingsRefinementService provides an interface for filtering out findings that are unlikely to be real threats to prevent them from triggering alerts or notifications.

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

FindingsRefinementServiceClient

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

Instantiates the findings refinement 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,FindingsRefinementServiceTransport,Callable[..., FindingsRefinementServiceTransport]]]` 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 FindingsRefinementServiceTransport 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.

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.

cancel_operation

cancel_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]
    ] = 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, 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.Retry` 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.

compute_all_findings_refinement_activities

compute_all_findings_refinement_activities(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.ComputeAllFindingsRefinementActivitiesRequest,
            dict,
        ]
    ] = None,
    *,
    instance: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.chronicle_v1.types.findings_refinement.ComputeAllFindingsRefinementActivitiesResponse
)

Returns findings refinement activity for all findings refinements.

# 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

def sample_compute_all_findings_refinement_activities():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.ComputeAllFindingsRefinementActivitiesRequest(
        instance="instance_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ComputeAllFindingsRefinementActivitiesRequest, dict]` The request object. Request message for ComputeAllFindingsRefinementActivities method.
`instance`	`str` Required. The ID of the Instance to retrieve counts for. Format: projects/{project}/locations/{location}/instances/{instance} This corresponds to the `instance` 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, 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.ComputeAllFindingsRefinementActivitiesResponse`	Response message for ComputeAllFindingsRefinementActivities method.

compute_findings_refinement_activity

compute_findings_refinement_activity(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.ComputeFindingsRefinementActivityRequest,
            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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.chronicle_v1.types.findings_refinement.ComputeFindingsRefinementActivityResponse
)

Returns findings refinement activity for a specific findings refinement.

# 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

def sample_compute_findings_refinement_activity():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ComputeFindingsRefinementActivityRequest, dict]` The request object. Request message for ComputeFindingsRefinementActivity method.
`name`	`str` Required. Full resource name for the findings refinement to fetch the activity for. Format: projects/{project}/locations/{region}/instances/{instance}/findingsRefinements/{findings_refinement} 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, 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.ComputeFindingsRefinementActivityResponse`	Response message for ComputeFindingsRefinementActivity method.

create_findings_refinement

create_findings_refinement(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.CreateFindingsRefinementRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    findings_refinement: typing.Optional[
        google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinement
    ] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinement

Creates a new findings refinement.

# 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

def sample_create_findings_refinement():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.CreateFindingsRefinementRequest, dict]` The request object. Request message for CreateFindingsRefinement method.
`parent`	`str` Required. The parent resource where this findings refinement 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.
`findings_refinement`	`google.cloud.chronicle_v1.types.FindingsRefinement` Required. The findings refinement to create. This corresponds to the `findings_refinement` 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, 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.FindingsRefinement`	Represents a set of logic conditions used to refine various types of findings such as curated rule detections.

curated_rule_path

curated_rule_path(
    project: str, location: str, instance: str, curatedRule: str
) -> str

Returns a fully-qualified curated_rule string.

curated_rule_set_path

curated_rule_set_path(
    project: str, location: str, instance: str, category: str, rule_set: str
) -> str

Returns a fully-qualified curated_rule_set string.

delete_operation

delete_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, dict]
    ] = 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, 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.Retry` 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`.

findings_refinement_deployment_path

findings_refinement_deployment_path(
    project: str, location: str, instance: str, findings_refinement: str
) -> str

Returns a fully-qualified findings_refinement_deployment string.

findings_refinement_path

findings_refinement_path(
    project: str, location: str, instance: str, findings_refinement: str
) -> str

Returns a fully-qualified findings_refinement 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
`FindingsRefinementServiceClient`	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
`FindingsRefinementServiceClient`	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
`FindingsRefinementServiceClient`	The constructed client.

get_findings_refinement

get_findings_refinement(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.GetFindingsRefinementRequest,
            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, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinement

Gets a single findings refinement.

# 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

def sample_get_findings_refinement():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.GetFindingsRefinementRequest, dict]` The request object. Request message for GetFindingsRefinement method.
`name`	`str` Required. The name of the findings refinement to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement} 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, 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.FindingsRefinement`	Represents a set of logic conditions used to refine various types of findings such as curated rule detections.

get_findings_refinement_deployment

get_findings_refinement_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.GetFindingsRefinementDeploymentRequest,
            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, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinementDeployment

Gets a findings refinement deployment.

# 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

def sample_get_findings_refinement_deployment():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.GetFindingsRefinementDeploymentRequest, dict]` The request object. Request message for GetFindingsRefinementDeployment method.
`name`	`str` Required. The name of the findings refinement to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}/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.Retry` 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.FindingsRefinementDeployment`	The FindingsRefinementDeployment resource represents the deployment state of a findings refinement.

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 `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[
        typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict]
    ] = 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, 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.Retry` 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.

instance_path

instance_path(project: str, location: str, instance: str) -> str

Returns a fully-qualified instance string.

list_all_findings_refinement_deployments

list_all_findings_refinement_deployments(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.ListAllFindingsRefinementDeploymentsRequest,
            dict,
        ]
    ] = None,
    *,
    instance: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.chronicle_v1.services.findings_refinement_service.pagers.ListAllFindingsRefinementDeploymentsPager
)

Lists all findings refinement deployments.

# 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

def sample_list_all_findings_refinement_deployments():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListAllFindingsRefinementDeploymentsRequest(
        instance="instance_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ListAllFindingsRefinementDeploymentsRequest, dict]` The request object. Request message for ListAllFindingsRefinementDeployments method.
`instance`	`str` Required. The name of the parent resource, which is the SecOps instance to list all findings refinement deployments over. Format: projects/{project}/locations/{location}/instances/{instance} This corresponds to the `instance` 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, 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.findings_refinement_service.pagers.ListAllFindingsRefinementDeploymentsPager`	Response message for ListAllFindingsRefinementDeployments method. Iterating over this object will yield results and resolve additional pages automatically.

list_findings_refinements

list_findings_refinements(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.ListFindingsRefinementsRequest,
            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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.chronicle_v1.services.findings_refinement_service.pagers.ListFindingsRefinementsPager
)

Lists a collection of findings refinements.

# 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

def sample_list_findings_refinements():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ListFindingsRefinementsRequest, dict]` The request object. Request message for ListFindingsRefinements method.
`parent`	`str` Required. The parent, which owns this collection of findings refinements. 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.Retry` 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.findings_refinement_service.pagers.ListFindingsRefinementsPager`	Response message for ListFindingsRefinements method. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict]
    ] = 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, 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.Retry` 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.

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_curated_rule_path

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

Parses a curated_rule path into its component segments.

parse_curated_rule_set_path

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

Parses a curated_rule_set path into its component segments.

parse_findings_refinement_deployment_path

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

Parses a findings_refinement_deployment path into its component segments.

parse_findings_refinement_path

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

Parses a findings_refinement path into its component segments.

parse_instance_path

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

Parses a instance 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.

rule_path

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

Returns a fully-qualified rule string.

update_findings_refinement

update_findings_refinement(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.UpdateFindingsRefinementRequest,
            dict,
        ]
    ] = None,
    *,
    findings_refinement: typing.Optional[
        google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinement
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinement

Updates a findings refinement.

# 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

def sample_update_findings_refinement():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.UpdateFindingsRefinementRequest, dict]` The request object. Request message for UpdateFindingsRefinement method.
`findings_refinement`	`google.cloud.chronicle_v1.types.FindingsRefinement` Required. The findings refinement to update. The findings refinement's `name` field is used to identify the findings refinement to update. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement} This corresponds to the `findings_refinement` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Optional. The list of fields to update. If `*` is provided, all fields will be 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, 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.FindingsRefinement`	Represents a set of logic conditions used to refine various types of findings such as curated rule detections.

update_findings_refinement_deployment

update_findings_refinement_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.findings_refinement.UpdateFindingsRefinementDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    findings_refinement_deployment: typing.Optional[
        google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinementDeployment
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.findings_refinement.FindingsRefinementDeployment

Updates a findings refinement deployment.

# 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

def sample_update_findings_refinement_deployment():
    # Create a client
    client = chronicle_v1.FindingsRefinementServiceClient()

    # Initialize request argument(s)
    findings_refinement_deployment = chronicle_v1.FindingsRefinementDeployment()
    findings_refinement_deployment.name = "name_value"

    request = chronicle_v1.UpdateFindingsRefinementDeploymentRequest(
        findings_refinement_deployment=findings_refinement_deployment,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.UpdateFindingsRefinementDeploymentRequest, dict]` The request object. Request message for UpdateFindingsRefinementDeployment method.
`findings_refinement_deployment`	`google.cloud.chronicle_v1.types.FindingsRefinementDeployment` Required. The findings refinement deployment to update. The findings refinement deployment's `name` field is used to identify the findings refinement deployment to update. Format: projects/{project}/locations/{location}/instances/{instance}/findingsRefinements/{findings_refinement}/deployment This corresponds to the `findings_refinement_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. If `*` is provided, all fields will be 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, 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.FindingsRefinementDeployment`	The FindingsRefinementDeployment resource represents the deployment state of a findings refinement.