Class NativeDashboardServiceClient (0.6.0)

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

A service providing functionality for managing native dashboards.

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

NativeDashboardServiceClient

NativeDashboardServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.chronicle_v1.services.native_dashboard_service.transports.base.NativeDashboardServiceTransport,
            typing.Callable[
                [...],
                google.cloud.chronicle_v1.services.native_dashboard_service.transports.base.NativeDashboardServiceTransport,
            ],
        ]
    ] = 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 native dashboard 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,NativeDashboardServiceTransport,Callable[..., NativeDashboardServiceTransport]]]` 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 NativeDashboardServiceTransport 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.

add_chart

add_chart(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.AddChartRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    dashboard_query: typing.Optional[
        google.cloud.chronicle_v1.types.dashboard_query.DashboardQuery
    ] = None,
    dashboard_chart: typing.Optional[
        google.cloud.chronicle_v1.types.dashboard_chart.DashboardChart
    ] = 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.native_dashboard.AddChartResponse

Add chart in a dashboard.

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

    # Initialize request argument(s)
    dashboard_chart = chronicle_v1.DashboardChart()
    dashboard_chart.display_name = "display_name_value"

    request = chronicle_v1.AddChartRequest(
        name="name_value",
        dashboard_chart=dashboard_chart,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.AddChartRequest, dict]` The request object. Request message to add chart in a dashboard.
`name`	`str` Required. The dashboard name to add chart in. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`dashboard_query`	`google.cloud.chronicle_v1.types.DashboardQuery` Optional. Query used to create the chart. This corresponds to the `dashboard_query` field on the `request` instance; if `request` is provided, this should not be set.
`dashboard_chart`	`google.cloud.chronicle_v1.types.DashboardChart` Required. Chart to be added to the dashboard. This corresponds to the `dashboard_chart` 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.AddChartResponse`	Response message for adding chart in a dashboard.

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_native_dashboard

create_native_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.CreateNativeDashboardRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    native_dashboard: typing.Optional[
        google.cloud.chronicle_v1.types.native_dashboard.NativeDashboard
    ] = 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.native_dashboard.NativeDashboard

Create a dashboard.

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

    # Initialize request argument(s)
    native_dashboard = chronicle_v1.NativeDashboard()
    native_dashboard.display_name = "display_name_value"

    request = chronicle_v1.CreateNativeDashboardRequest(
        parent="parent_value",
        native_dashboard=native_dashboard,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.CreateNativeDashboardRequest, dict]` The request object. Request message to create a dashboard.
`parent`	`str` Required. The parent resource where this dashboard 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.
`native_dashboard`	`google.cloud.chronicle_v1.types.NativeDashboard` Required. The dashboard to create. This corresponds to the `native_dashboard` 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.NativeDashboard`	NativeDashboard resource.

dashboard_chart_path

dashboard_chart_path(project: str, location: str, instance: str, chart: str) -> str

Returns a fully-qualified dashboard_chart string.

dashboard_query_path

dashboard_query_path(project: str, location: str, instance: str, query: str) -> str

Returns a fully-qualified dashboard_query string.

delete_native_dashboard

delete_native_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.DeleteNativeDashboardRequest,
            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 a dashboard.

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.DeleteNativeDashboardRequest, dict]` The request object. Request message to delete a dashboard.
`name`	`str` Required. The dashboard name to delete. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} 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`.

duplicate_chart

duplicate_chart(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.DuplicateChartRequest, 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.native_dashboard.DuplicateChartResponse

Duplicate chart in a dashboard.

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

    # Initialize request argument(s)
    request = chronicle_v1.DuplicateChartRequest(
        name="name_value",
        dashboard_chart="dashboard_chart_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.DuplicateChartRequest, dict]` The request object. Request message to duplicate chart in a dashboard.
`name`	`str` Required. The dashboard name that involves chart duplication. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} 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.DuplicateChartResponse`	Response message for duplicating chart in a dashboard.

duplicate_native_dashboard

duplicate_native_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.DuplicateNativeDashboardRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    native_dashboard: typing.Optional[
        google.cloud.chronicle_v1.types.native_dashboard.NativeDashboard
    ] = 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.native_dashboard.NativeDashboard

Duplicate a dashboard.

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

    # Initialize request argument(s)
    native_dashboard = chronicle_v1.NativeDashboard()
    native_dashboard.display_name = "display_name_value"

    request = chronicle_v1.DuplicateNativeDashboardRequest(
        name="name_value",
        native_dashboard=native_dashboard,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.DuplicateNativeDashboardRequest, dict]` The request object. Request message to duplicate a dashboard.
`name`	`str` Required. The dashboard name to duplicate. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`native_dashboard`	`google.cloud.chronicle_v1.types.NativeDashboard` Required. Any fields that need modification can be passed through this like name, description etc. This corresponds to the `native_dashboard` 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.NativeDashboard`	NativeDashboard resource.

edit_chart

edit_chart(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.EditChartRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    dashboard_query: typing.Optional[
        google.cloud.chronicle_v1.types.dashboard_query.DashboardQuery
    ] = None,
    dashboard_chart: typing.Optional[
        google.cloud.chronicle_v1.types.dashboard_chart.DashboardChart
    ] = None,
    edit_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.native_dashboard.EditChartResponse

Edit chart in a dashboard.

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

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.EditChartRequest, dict]` The request object. Request message to edit chart in a dashboard.
`name`	`str` Required. The dashboard name to edit chart in. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`dashboard_query`	`google.cloud.chronicle_v1.types.DashboardQuery` Optional. Query for the edited chart. This corresponds to the `dashboard_query` field on the `request` instance; if `request` is provided, this should not be set.
`dashboard_chart`	`google.cloud.chronicle_v1.types.DashboardChart` Optional. Edited chart. This corresponds to the `dashboard_chart` field on the `request` instance; if `request` is provided, this should not be set.
`edit_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The list of fields to edit for chart and query. Supported paths in chart are - dashboard_chart.display_name dashboard_chart.description dashboard_chart.chart_datasource.data_sources dashboard_chart.visualization dashboard_chart.visualization.button dashboard_chart.visualization.markdown dashboard_chart.drill_down_config Supported paths in query are - dashboard_query.query dashboard_query.input This corresponds to the `edit_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.EditChartResponse`	Response message for editing chart in a dashboard.

export_native_dashboards

export_native_dashboards(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.ExportNativeDashboardsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    names: typing.Optional[typing.MutableSequence[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.native_dashboard.ExportNativeDashboardsResponse

Exports the dashboards.

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

    # Initialize request argument(s)
    request = chronicle_v1.ExportNativeDashboardsRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ExportNativeDashboardsRequest, dict]` The request object. Request message to export list of dashboard.
`parent`	`str` Required. The parent resource that the dashboards to be exported belong to. 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.
`names`	`MutableSequence[str]` Required. The resource names of the dashboards to export. This corresponds to the `names` 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.ExportNativeDashboardsResponse`	Response message for exporting a dashboard.

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

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `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_native_dashboard

get_native_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.GetNativeDashboardRequest,
            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.native_dashboard.NativeDashboard

Get a dashboard.

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

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.GetNativeDashboardRequest, dict]` The request object. Request message to get a dashboard.
`name`	`str` Required. The dashboard name to fetch. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} 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.NativeDashboard`	NativeDashboard resource.

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.

import_native_dashboards

import_native_dashboards(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.ImportNativeDashboardsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    source: typing.Optional[
        google.cloud.chronicle_v1.types.native_dashboard.ImportNativeDashboardsInlineSource
    ] = 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.native_dashboard.ImportNativeDashboardsResponse

Imports the dashboards.

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

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ImportNativeDashboardsRequest, dict]` The request object. Request message to import dashboards.
`parent`	`str` Required. The parent resource where this dashboard 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.
`source`	`google.cloud.chronicle_v1.types.ImportNativeDashboardsInlineSource` Required. The data will imported from this proto. This corresponds to the `source` 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.ImportNativeDashboardsResponse`	Response message for importing dashboards.

list_native_dashboards

list_native_dashboards(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.ListNativeDashboardsRequest,
            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.native_dashboard_service.pagers.ListNativeDashboardsPager
)

List all dashboards.

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

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

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.ListNativeDashboardsRequest, dict]` The request object. Request message to list dashboards.
`parent`	`str` Required. The parent owning this dashboard collection. 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.native_dashboard_service.pagers.ListNativeDashboardsPager`	Response message for listing dashboards. 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.

native_dashboard_path

native_dashboard_path(
    project: str, location: str, instance: str, dashboard: str
) -> str

Returns a fully-qualified native_dashboard string.

parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

parse_common_folder_path

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

Parse a folder path into its component segments.

parse_common_location_path

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

Parse a location path into its component segments.

parse_common_organization_path

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

Parse a organization path into its component segments.

parse_common_project_path

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

Parse a project path into its component segments.

parse_dashboard_chart_path

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

Parses a dashboard_chart path into its component segments.

parse_dashboard_query_path

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

Parses a dashboard_query path into its component segments.

parse_native_dashboard_path

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

Parses a native_dashboard path into its component segments.

remove_chart

remove_chart(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.RemoveChartRequest, 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.native_dashboard.NativeDashboard

Remove chart from a dashboard.

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

    # Initialize request argument(s)
    request = chronicle_v1.RemoveChartRequest(
        name="name_value",
        dashboard_chart="dashboard_chart_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.RemoveChartRequest, dict]` The request object. Request message to remove chart from a dashboard.
`name`	`str` Required. The dashboard name to remove chart from. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} 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.NativeDashboard`	NativeDashboard resource.

update_native_dashboard

update_native_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.native_dashboard.UpdateNativeDashboardRequest,
            dict,
        ]
    ] = None,
    *,
    native_dashboard: typing.Optional[
        google.cloud.chronicle_v1.types.native_dashboard.NativeDashboard
    ] = 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.native_dashboard.NativeDashboard

Update a dashboard.

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

    # Initialize request argument(s)
    native_dashboard = chronicle_v1.NativeDashboard()
    native_dashboard.display_name = "display_name_value"

    request = chronicle_v1.UpdateNativeDashboardRequest(
        native_dashboard=native_dashboard,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.chronicle_v1.types.UpdateNativeDashboardRequest, dict]` The request object. Request message to update a dashboard.
`native_dashboard`	`google.cloud.chronicle_v1.types.NativeDashboard` Required. The dashboard to update. The dashboard's `name` field is used to identify the dashboard to update. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} This corresponds to the `native_dashboard` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. LINT.IfChange(update_mask_values) The list of fields to update. Supported paths are - display_name description definition.filters definition.charts type access dashboard_user_data.is_pinned 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.NativeDashboard`	NativeDashboard resource.