Class DashboardsServiceClient (2.16.1) 

DashboardsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_dashboard_v1.services.dashboards_service.transports.base.DashboardsServiceTransport, typing.Callable[[...], google.cloud.monitoring_dashboard_v1.services.dashboards_service.transports.base.DashboardsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.

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

DashboardsServiceClient

DashboardsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_dashboard_v1.services.dashboards_service.transports.base.DashboardsServiceTransport, typing.Callable[[...], google.cloud.monitoring_dashboard_v1.services.dashboards_service.transports.base.DashboardsServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the dashboards 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,DashboardsServiceTransport,Callable[..., DashboardsServiceTransport]]]

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

alert_policy_path

alert_policy_path(project: str, alert_policy: str) -> str

Returns a fully-qualified alert_policy string.

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_dashboard

create_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_dashboard_v1.types.dashboards_service.CreateDashboardRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    dashboard: typing.Optional[
        google.cloud.monitoring_dashboard_v1.types.dashboard.Dashboard
    ] = 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, str]] = ()
) -> google.cloud.monitoring_dashboard_v1.types.dashboard.Dashboard

Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API <https://cloud.google.com/monitoring/dashboards/api-dashboard>. This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management <https://cloud.google.com/iam>.

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

def sample_create_dashboard():
    # Create a client
    client = monitoring_dashboard_v1.DashboardsServiceClient()

    # Initialize request argument(s)
    dashboard = monitoring_dashboard_v1.Dashboard()
    dashboard.display_name = "display_name_value"

    request = monitoring_dashboard_v1.CreateDashboardRequest(
        parent="parent_value",
        dashboard=dashboard,
    )

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

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

The request object. The CreateDashboard request.
parent str

Required. The project on which to execute the request. The format is: :: projects/[PROJECT_ID_OR_NUMBER] The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
dashboard google.cloud.monitoring_dashboard_v1.types.Dashboard

Required. The initial dashboard specification. This corresponds to the 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, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.monitoring_dashboard_v1.types.Dashboard A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.

dashboard_path

dashboard_path(project: str, dashboard: str) -> str

Returns a fully-qualified dashboard string.

delete_dashboard

delete_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_dashboard_v1.types.dashboards_service.DeleteDashboardRequest,
            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, str]] = ()
) -> None

Deletes an existing custom dashboard.

This method requires the monitoring.dashboards.delete permission on the specified dashboard. For more information, see Cloud Identity and Access Management <https://cloud.google.com/iam>__.

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

def sample_delete_dashboard():
    # Create a client
    client = monitoring_dashboard_v1.DashboardsServiceClient()

    # Initialize request argument(s)
    request = monitoring_dashboard_v1.DeleteDashboardRequest(
        name="name_value",
    )

    # Make the request
    client.delete_dashboard(request=request)
Parameters
Name Description
request Union[google.cloud.monitoring_dashboard_v1.types.DeleteDashboardRequest, dict]

The request object. The DeleteDashboard request.
name str

Required. The resource name of the Dashboard. The format is: :: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] 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, str]]

Strings which should be sent along with the request as metadata.

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

get_dashboard

get_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_dashboard_v1.types.dashboards_service.GetDashboardRequest,
            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, str]] = ()
) -> google.cloud.monitoring_dashboard_v1.types.dashboard.Dashboard

Fetches a specific dashboard.

This method requires the monitoring.dashboards.get permission on the specified dashboard. For more information, see Cloud Identity and Access Management <https://cloud.google.com/iam>__.

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

def sample_get_dashboard():
    # Create a client
    client = monitoring_dashboard_v1.DashboardsServiceClient()

    # Initialize request argument(s)
    request = monitoring_dashboard_v1.GetDashboardRequest(
        name="name_value",
    )

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

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

The request object. The GetDashboard request.
name str

Required. The resource name of the Dashboard. The format is one of: - dashboards/[DASHBOARD_ID] (for system dashboards) - projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom dashboards). 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, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.monitoring_dashboard_v1.types.Dashboard A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.

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.

list_dashboards

list_dashboards(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsRequest,
            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, str]] = ()
) -> (
    google.cloud.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsPager
)

Lists the existing dashboards.

This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Cloud Identity and Access Management <https://cloud.google.com/iam>__.

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

def sample_list_dashboards():
    # Create a client
    client = monitoring_dashboard_v1.DashboardsServiceClient()

    # Initialize request argument(s)
    request = monitoring_dashboard_v1.ListDashboardsRequest(
        parent="parent_value",
    )

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

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

The request object. The ListDashboards request.
parent str

Required. The scope of the dashboards to list. The format is: :: projects/[PROJECT_ID_OR_NUMBER] 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, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsPager The ListDashboards request. Iterating over this object will yield results and resolve additional pages automatically.

parse_alert_policy_path

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

Parses a alert_policy path into its component segments.

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_path

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

Parses a dashboard path into its component segments.

update_dashboard

update_dashboard(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_dashboard_v1.types.dashboards_service.UpdateDashboardRequest,
            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, str]] = ()
) -> google.cloud.monitoring_dashboard_v1.types.dashboard.Dashboard

Replaces an existing custom dashboard with a new definition.

This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Cloud Identity and Access Management <https://cloud.google.com/iam>__.

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

def sample_update_dashboard():
    # Create a client
    client = monitoring_dashboard_v1.DashboardsServiceClient()

    # Initialize request argument(s)
    dashboard = monitoring_dashboard_v1.Dashboard()
    dashboard.display_name = "display_name_value"

    request = monitoring_dashboard_v1.UpdateDashboardRequest(
        dashboard=dashboard,
    )

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

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

The request object. The UpdateDashboard request.
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, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.monitoring_dashboard_v1.types.Dashboard A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.