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

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

DataAccessControlService exposes resources and endpoints related to data access control.

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

DataAccessControlServiceClient

DataAccessControlServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.chronicle_v1.services.data_access_control_service.transports.base.DataAccessControlServiceTransport, typing.Callable[[...], google.cloud.chronicle_v1.services.data_access_control_service.transports.base.DataAccessControlServiceTransport]]] = 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 data access control 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,DataAccessControlServiceTransport,Callable[..., DataAccessControlServiceTransport]]]` 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 DataAccessControlServiceTransport 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[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = 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.

create_data_access_label

create_data_access_label(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.CreateDataAccessLabelRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    data_access_label: typing.Optional[
        google.cloud.chronicle_v1.types.data_access_control.DataAccessLabel
    ] = None,
    data_access_label_id: 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.data_access_control.DataAccessLabel

Creates a data access label. Data access labels are applied to incoming event data and selected in data access scopes (another resource), and only users with scopes containing the label can see data with that label. Currently, the data access label resource only includes custom labels, which are labels that correspond to UDM queries over event data.

# 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_data_access_label():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

    # Initialize request argument(s)
    data_access_label = chronicle_v1.DataAccessLabel()
    data_access_label.udm_query = "udm_query_value"

    request = chronicle_v1.CreateDataAccessLabelRequest(
        parent="parent_value",
        data_access_label=data_access_label,
        data_access_label_id="data_access_label_id_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.CreateDataAccessLabelRequest, dict]` The request object. Request message for CreateDataAccessLabel.
`parent`	`str` Required. The parent resource where this Data Access Label 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.
`data_access_label`	`google.cloud.chronicle_v1.types.DataAccessLabel` Required. Data access label to create. This corresponds to the `data_access_label` field on the `request` instance; if `request` is provided, this should not be set.
`data_access_label_id`	`str` Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments This corresponds to the `data_access_label_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, 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.DataAccessLabel`	A DataAccessLabel is a label on events to define user access to data.

create_data_access_scope

create_data_access_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.CreateDataAccessScopeRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    data_access_scope: typing.Optional[
        google.cloud.chronicle_v1.types.data_access_control.DataAccessScope
    ] = None,
    data_access_scope_id: 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.data_access_control.DataAccessScope

Creates a data access scope. Data access scope is a combination of allowed and denied labels attached to a permission group. If a scope has allowed labels A and B and denied labels C and D, then the group of people attached to the scope will have permissions to see all events labeled with A or B (or both) and not labeled with either C or D.

# 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_data_access_scope():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

    # Initialize request argument(s)
    data_access_scope = chronicle_v1.DataAccessScope()
    data_access_scope.name = "name_value"

    request = chronicle_v1.CreateDataAccessScopeRequest(
        parent="parent_value",
        data_access_scope=data_access_scope,
        data_access_scope_id="data_access_scope_id_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.CreateDataAccessScopeRequest, dict]` The request object. Request message for CreateDataAccessScope.
`parent`	`str` Required. The parent resource where this Data Access Scope 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.
`data_access_scope`	`google.cloud.chronicle_v1.types.DataAccessScope` Required. Data access scope to create. This corresponds to the `data_access_scope` field on the `request` instance; if `request` is provided, this should not be set.
`data_access_scope_id`	`str` Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122 This corresponds to the `data_access_scope_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, 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.DataAccessScope`	A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.

data_access_label_path

data_access_label_path(
    project: str, location: str, instance: str, data_access_label: str
) -> str

Returns a fully-qualified data_access_label string.

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_data_access_label

delete_data_access_label(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.DeleteDataAccessLabelRequest,
            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]]] = ()
) -> None

Deletes a data access label. When a label is deleted, new data that enters in the system will not receive the label, but the label will not be removed from old data that still refers to it.

# 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_delete_data_access_label():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.DeleteDataAccessLabelRequest, dict]` The request object. Request message to delete a data access label.
`name`	`str` Required. The ID of the data access label to delete. Format: `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}` 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`.

delete_data_access_scope

delete_data_access_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.DeleteDataAccessScopeRequest,
            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]]] = ()
) -> None

Deletes a data access scope.

# 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_delete_data_access_scope():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.DeleteDataAccessScopeRequest, dict]` The request object. Request message to delete a data access scope.
`name`	`str` Required. The ID of the data access scope to delete. Format: `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}` 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`.

delete_operation

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

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
`DataAccessControlServiceClient`	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
`DataAccessControlServiceClient`	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
`DataAccessControlServiceClient`	The constructed client.

get_data_access_label

get_data_access_label(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.GetDataAccessLabelRequest,
            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.data_access_control.DataAccessLabel

Gets a data access label.

# 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_data_access_label():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.GetDataAccessLabelRequest, dict]` The request object. Request message to retrieve a data access label.
`name`	`str` Required. The ID of the data access label to retrieve. Format: `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}` 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.DataAccessLabel`	A DataAccessLabel is a label on events to define user access to data.

get_data_access_scope

get_data_access_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.GetDataAccessScopeRequest,
            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.data_access_control.DataAccessScope

Retrieves an existing data access scope.

# 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_data_access_scope():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.GetDataAccessScopeRequest, dict]` The request object. Request message to retrieve a data access scope.
`name`	`str` Required. The ID of the data access scope to retrieve. Format: `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}` 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.DataAccessScope`	A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.

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[
        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, 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.

list_data_access_labels

list_data_access_labels(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.ListDataAccessLabelsRequest,
            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.data_access_control_service.pagers.ListDataAccessLabelsPager
)

Lists all data access labels for the customer.

# 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_data_access_labels():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ListDataAccessLabelsRequest, dict]` The request object. Request message for ListDataAccessLabels.
`parent`	`str` Required. The parent resource where this data access label 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.
`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.data_access_control_service.pagers.ListDataAccessLabelsPager`	Response message for ListDataAccessLabels. Iterating over this object will yield results and resolve additional pages automatically.

list_data_access_scopes

list_data_access_scopes(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.ListDataAccessScopesRequest,
            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.data_access_control_service.pagers.ListDataAccessScopesPager
)

Lists all existing data access scopes for the customer.

# 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_data_access_scopes():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ListDataAccessScopesRequest, dict]` The request object. Request message for ListDataAccessScopes.
`parent`	`str` Required. The parent resource where this data access scope 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.
`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.data_access_control_service.pagers.ListDataAccessScopesPager`	Response message for ListDataAccessScopes. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = 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_data_access_label_path

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

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

update_data_access_label

update_data_access_label(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.UpdateDataAccessLabelRequest,
            dict,
        ]
    ] = None,
    *,
    data_access_label: typing.Optional[
        google.cloud.chronicle_v1.types.data_access_control.DataAccessLabel
    ] = 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.data_access_control.DataAccessLabel

Updates a data access label.

# 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_data_access_label():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

    # Initialize request argument(s)
    data_access_label = chronicle_v1.DataAccessLabel()
    data_access_label.udm_query = "udm_query_value"

    request = chronicle_v1.UpdateDataAccessLabelRequest(
        data_access_label=data_access_label,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.UpdateDataAccessLabelRequest, dict]` The request object. Request message for UpdateDataAccessLabel method.
`data_access_label`	`google.cloud.chronicle_v1.types.DataAccessLabel` Required. The data access label to update. The label's `name` field is used to identify the label to update. Format: `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}` This corresponds to the `data_access_label` 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. Currently, only the description and definition fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT. 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.DataAccessLabel`	A DataAccessLabel is a label on events to define user access to data.

update_data_access_scope

update_data_access_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_access_control.UpdateDataAccessScopeRequest,
            dict,
        ]
    ] = None,
    *,
    data_access_scope: typing.Optional[
        google.cloud.chronicle_v1.types.data_access_control.DataAccessScope
    ] = 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.data_access_control.DataAccessScope

Updates a data access scope.

# 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_data_access_scope():
    # Create a client
    client = chronicle_v1.DataAccessControlServiceClient()

    # Initialize request argument(s)
    data_access_scope = chronicle_v1.DataAccessScope()
    data_access_scope.name = "name_value"

    request = chronicle_v1.UpdateDataAccessScopeRequest(
        data_access_scope=data_access_scope,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.UpdateDataAccessScopeRequest, dict]` The request object. Request message for UpdateDataAccessScope method.
`data_access_scope`	`google.cloud.chronicle_v1.types.DataAccessScope` Required. The data access scope to update. The scope's `name` field is used to identify the scope to update. Format: `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}` This corresponds to the `data_access_scope` 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. Currently, only the description, the allowed and denied labels list fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT. 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.DataAccessScope`	A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.