Class DataTableServiceClient (0.5.0)

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

DataTableManager provides an interface for managing data tables.

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
DataTableServiceTransport 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

DataTableServiceClient

DataTableServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.chronicle_v1.services.data_table_service.transports.base.DataTableServiceTransport,
            typing.Callable[
                [...],
                google.cloud.chronicle_v1.services.data_table_service.transports.base.DataTableServiceTransport,
            ],
        ]
    ] = 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 data table 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,DataTableServiceTransport,Callable[..., DataTableServiceTransport]]]

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 DataTableServiceTransport 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.

bulk_create_data_table_rows

bulk_create_data_table_rows(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.BulkCreateDataTableRowsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.chronicle_v1.types.data_table.CreateDataTableRowRequest
        ]
    ] = 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_table.BulkCreateDataTableRowsResponse

Create data table rows in bulk.

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

    # Initialize request argument(s)
    requests = chronicle_v1.CreateDataTableRowRequest()
    requests.parent = "parent_value"
    requests.data_table_row.values = ['values_value1', 'values_value2']

    request = chronicle_v1.BulkCreateDataTableRowsRequest(
        parent="parent_value",
        requests=requests,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.BulkCreateDataTableRowsRequest, dict]

The request object. Request to create data table rows in bulk.

parent str

Required. The resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

requests MutableSequence[google.cloud.chronicle_v1.types.CreateDataTableRowRequest]

Required. Data table rows to create. A maximum of 1000 rows (for sync requests) or 2000 rows (for async requests) can be created in a single request. Total size of the rows should be less than 4MB. This corresponds to the requests 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.BulkCreateDataTableRowsResponse Response message with created data table rows.

bulk_get_data_table_rows

bulk_get_data_table_rows(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.BulkGetDataTableRowsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.chronicle_v1.types.data_table.GetDataTableRowRequest
        ]
    ] = 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_table.BulkGetDataTableRowsResponse

Get data table rows in bulk.

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

    # Initialize request argument(s)
    requests = chronicle_v1.GetDataTableRowRequest()
    requests.name = "name_value"

    request = chronicle_v1.BulkGetDataTableRowsRequest(
        parent="parent_value",
        requests=requests,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.BulkGetDataTableRowsRequest, dict]

The request object. Request to get data table rows in bulk.

parent str

Required. The resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

requests MutableSequence[google.cloud.chronicle_v1.types.GetDataTableRowRequest]

Required. Data table rows to get. At max 1,000 rows can be there in a request. This corresponds to the requests 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.BulkGetDataTableRowsResponse Response message with data table rows.

bulk_replace_data_table_rows

bulk_replace_data_table_rows(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.BulkReplaceDataTableRowsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.chronicle_v1.types.data_table.CreateDataTableRowRequest
        ]
    ] = 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_table.BulkReplaceDataTableRowsResponse

Replace all existing data table rows with new data table rows.

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

    # Initialize request argument(s)
    requests = chronicle_v1.CreateDataTableRowRequest()
    requests.parent = "parent_value"
    requests.data_table_row.values = ['values_value1', 'values_value2']

    request = chronicle_v1.BulkReplaceDataTableRowsRequest(
        parent="parent_value",
        requests=requests,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.BulkReplaceDataTableRowsRequest, dict]

The request object. Request to replace data table rows in bulk.

parent str

Required. The resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

requests MutableSequence[google.cloud.chronicle_v1.types.CreateDataTableRowRequest]

Required. Data table rows to replace the existing data table rows. A maximum of 1000 rows (for sync requests) or 2000 rows (for async requests) can be replaced in a single request. Total size of the rows should be less than 4MB. This corresponds to the requests 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.BulkReplaceDataTableRowsResponse Response message with data table rows that replaced existing data table rows.

bulk_update_data_table_rows

bulk_update_data_table_rows(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.BulkUpdateDataTableRowsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    requests: typing.Optional[
        typing.MutableSequence[
            google.cloud.chronicle_v1.types.data_table.UpdateDataTableRowRequest
        ]
    ] = 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_table.BulkUpdateDataTableRowsResponse

Update data table rows in bulk.

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

    # Initialize request argument(s)
    requests = chronicle_v1.UpdateDataTableRowRequest()
    requests.data_table_row.values = ['values_value1', 'values_value2']

    request = chronicle_v1.BulkUpdateDataTableRowsRequest(
        parent="parent_value",
        requests=requests,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.BulkUpdateDataTableRowsRequest, dict]

The request object. Request to update data table rows in bulk.

parent str

Required. The resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

requests MutableSequence[google.cloud.chronicle_v1.types.UpdateDataTableRowRequest]

Required. Data table rows to update. At max 1,000 rows (or rows with size less than 2MB) can be there in a request. This corresponds to the requests 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.BulkUpdateDataTableRowsResponse Response message with updated data table rows.

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.

create_data_table

create_data_table(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.CreateDataTableRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    data_table: typing.Optional[
        google.cloud.chronicle_v1.types.data_table.DataTable
    ] = None,
    data_table_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_table.DataTable

Create a new data table.

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

    # Initialize request argument(s)
    data_table = chronicle_v1.DataTable()
    data_table.description = "description_value"

    request = chronicle_v1.CreateDataTableRequest(
        parent="parent_value",
        data_table=data_table,
        data_table_id="data_table_id_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.CreateDataTableRequest, dict]

The request object. A request to create DataTable.

parent str

Required. The parent resource where this data table 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_table google.cloud.chronicle_v1.types.DataTable

Required. The data table being created. This corresponds to the data_table field on the request instance; if request is provided, this should not be set.

data_table_id str

Required. The ID to use for the data table. This is also the display name for the data table. It must satisfy the following requirements: - Starts with letter. - Contains only letters, numbers and underscore. - Must be unique and has length < 256. This corresponds to the data_table_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.DataTable DataTable represents the data table resource.

create_data_table_row

create_data_table_row(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.CreateDataTableRowRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    data_table_row: typing.Optional[
        google.cloud.chronicle_v1.types.data_table.DataTableRow
    ] = 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_table.DataTableRow

Create a new data table row.

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

    # Initialize request argument(s)
    data_table_row = chronicle_v1.DataTableRow()
    data_table_row.values = ['values_value1', 'values_value2']

    request = chronicle_v1.CreateDataTableRowRequest(
        parent="parent_value",
        data_table_row=data_table_row,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.CreateDataTableRowRequest, dict]

The request object. Request to create data table row.

parent str

Required. The resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

data_table_row google.cloud.chronicle_v1.types.DataTableRow

Required. The data table row to create. This corresponds to the data_table_row 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.DataTableRow DataTableRow represents a single row in a data table.

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.

data_table_operation_errors_path

data_table_operation_errors_path(
    project: str, location: str, instance: str, data_table_operation_errors: str
) -> str

Returns a fully-qualified data_table_operation_errors string.

data_table_path

data_table_path(project: str, location: str, instance: str, data_table: str) -> str

Returns a fully-qualified data_table string.

data_table_row_path

data_table_row_path(
    project: str, location: str, instance: str, data_table: str, data_table_row: str
) -> str

Returns a fully-qualified data_table_row string.

delete_data_table

delete_data_table(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.DeleteDataTableRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    force: typing.Optional[bool] = 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

Delete data table.

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

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

    # Make the request
    client.delete_data_table(request=request)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.DeleteDataTableRequest, dict]

The request object. Request message for deleting data tables.

name str

Required. The resource name of the data table to delete. Format projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table} This corresponds to the name field on the request instance; if request is provided, this should not be set.

force bool

Optional. If set to true, any rows under this data table will also be deleted. (Otherwise, the request will only work if the data table has no rows.) This corresponds to the force 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_table_row

delete_data_table_row(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.DeleteDataTableRowRequest, 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

Delete data table row.

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

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

    # Make the request
    client.delete_data_table_row(request=request)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.DeleteDataTableRowRequest, dict]

The request object. Request to delete data table row.

name str

Required. The resource name of the data table row i,e row_id. Format: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} 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[
        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.

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

get_data_table

get_data_table(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.GetDataTableRequest, 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_table.DataTable

Get data table info.

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

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.GetDataTableRequest, dict]

The request object. A request to get details about a data table.

name str

Required. The resource name of the data table to retrieve. Format: projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table} 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.DataTable DataTable represents the data table resource.

get_data_table_operation_errors

get_data_table_operation_errors(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.GetDataTableOperationErrorsRequest,
            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_table.DataTableOperationErrors

Get the error for a data table operation.

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

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.GetDataTableOperationErrorsRequest, dict]

The request object. The request message for GetDataTableOperationErrors.

name str

Required. Resource name for the data table operation errors. Format: projects/{project}/locations/{location}/instances/{instance}/dataTableOperationErrors/{data_table_operation_errors} 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.DataTableOperationErrors The message containing the errors for a data table operation.

get_data_table_row

get_data_table_row(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.GetDataTableRowRequest, 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_table.DataTableRow

Get data table row

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

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.GetDataTableRowRequest, dict]

The request object. Request to get data table row.

name str

Required. The resource name of the data table row i,e row_id. Format: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} 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.DataTableRow DataTableRow represents a single row in a data table.

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.

list_data_table_rows

list_data_table_rows(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.ListDataTableRowsRequest, 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_table_service.pagers.ListDataTableRowsPager
)

List data table rows.

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

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

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.ListDataTableRowsRequest, dict]

The request object. Request to list data table rows.

parent str

Required. The resource id of the data table. Format: projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table} 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_table_service.pagers.ListDataTableRowsPager Response message for listing data table rows. Iterating over this object will yield results and resolve additional pages automatically.

list_data_tables

list_data_tables(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.ListDataTablesRequest, 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_table_service.pagers.ListDataTablesPager

List data tables.

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

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

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.ListDataTablesRequest, dict]

The request object. A request for a list of data tables.

parent str

Required. The parent resource where this data table 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_table_service.pagers.ListDataTablesPager Response message for listing data tables. 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_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_data_table_operation_errors_path

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

Parses a data_table_operation_errors path into its component segments.

parse_data_table_path

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

Parses a data_table path into its component segments.

parse_data_table_row_path

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

Parses a data_table_row path into its component segments.

update_data_table

update_data_table(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.UpdateDataTableRequest, dict
        ]
    ] = None,
    *,
    data_table: typing.Optional[
        google.cloud.chronicle_v1.types.data_table.DataTable
    ] = 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_table.DataTable

Update data table.

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

    # Initialize request argument(s)
    data_table = chronicle_v1.DataTable()
    data_table.description = "description_value"

    request = chronicle_v1.UpdateDataTableRequest(
        data_table=data_table,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.UpdateDataTableRequest, dict]

The request object. A request to update details of data table.

data_table google.cloud.chronicle_v1.types.DataTable

Required. This field is used to identify the datatable to update. Format: projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table} This corresponds to the data_table 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 metadata fields to update. Currently data tables only support updating the description, row_time_to_live and scope_info fields. When no field mask is supplied, all non-empty fields will be updated. A field mask of "*" will update all fields, whether empty or not. 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.DataTable DataTable represents the data table resource.

update_data_table_row

update_data_table_row(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.data_table.UpdateDataTableRowRequest, dict
        ]
    ] = None,
    *,
    data_table_row: typing.Optional[
        google.cloud.chronicle_v1.types.data_table.DataTableRow
    ] = 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_table.DataTableRow

Update data table row

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

    # Initialize request argument(s)
    data_table_row = chronicle_v1.DataTableRow()
    data_table_row.values = ['values_value1', 'values_value2']

    request = chronicle_v1.UpdateDataTableRowRequest(
        data_table_row=data_table_row,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.UpdateDataTableRowRequest, dict]

The request object. Request to update data table row.

data_table_row google.cloud.chronicle_v1.types.DataTableRow

Required. Format: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row} This corresponds to the data_table_row 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. Currently data table rows only support updating the values field. When no field mask is supplied, all non-empty fields will be updated. A field mask of "*" will update all fields, whether empty or not. 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.DataTableRow DataTableRow represents a single row in a data table.