Class DashboardsServiceClient (0.1.1)

Version 0.1.1

• 2.15.1 (latest)
• 2.15.0
• 2.14.1
• 2.13.0
• 2.12.3
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.4
• 2.6.1
• 2.5.1
• 2.4.1
• 2.3.0
• 2.2.4
• 2.1.0
• 2.0.0
• 1.0.2
• 0.1.2

DashboardsServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

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

Inheritance

builtins.object > google.cloud.monitoring_dashboard.v1.gapic.dashboards_service_client.DashboardsServiceClient > DashboardsServiceClient

Methods

DashboardsServiceClient

DashboardsServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters

Name	Description
channel	grpc.Channel DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
credentials	google.auth.credentials.Credentials The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
client_config	dict DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.
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.
client_options	Union[dict, google.api_core.client_options.ClientOptions] Client options used to set user options on the client. API Endpoint should be set through client_options.

create_dashboard

create_dashboard(parent, dashboard, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates a new custom dashboard.

This method requires the monitoring.dashboards.create permission on the specified project. For more information, see Google Cloud IAM <https://cloud.google.com/iam>__.

.. rubric:: Example

from google.cloud.monitoring_dashboard import v1

client = v1.DashboardsServiceClient()

TODO: Initialize parent:

parent = ''

TODO: Initialize dashboard:

dashboard = {}

response = client.create_dashboard(parent, dashboard)

Parameters

Name	Description
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.
dashboard	Union[dict, Dashboard] Required. The initial dashboard specification. If a dict is provided, it must be of the same form as the protobuf message Dashboard
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

delete_dashboard

delete_dashboard(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes an existing custom dashboard.

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

.. rubric:: Example

from google.cloud.monitoring_dashboard import v1

client = v1.DashboardsServiceClient()

TODO: Initialize name:

name = ''

client.delete_dashboard(name)

Parameters

Name	Description
name	str Required. The resource name of the Dashboard. The format is "projects/{project_id_or_number}/dashboards/{dashboard_id}".
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *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_json

from_service_account_json(filename, *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(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Fetches a specific dashboard.

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

.. rubric:: Example

from google.cloud.monitoring_dashboard import v1

client = v1.DashboardsServiceClient()

TODO: Initialize name:

name = ''

response = client.get_dashboard(name)

Parameters

Name	Description
name	str Required. The resource name of the Dashboard. The format is one of "dashboards/{dashboard_id}" (for system dashboards) or "projects/{project_id_or_number}/dashboards/{dashboard_id}" (for custom dashboards).
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

list_dashboards

list_dashboards(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists the existing dashboards.

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

.. rubric:: Example

from google.cloud.monitoring_dashboard import v1

client = v1.DashboardsServiceClient()

TODO: Initialize parent:

parent = ''

Iterate over all results

for element in client.list_dashboards(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_dashboards(parent).pages: ... for element in page: ... # process element ... pass

Parameters

Name	Description
parent	str Required. The scope of the dashboards to list. A project scope must be specified in the form of "projects/{project_id_or_number}".
page_size	int The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.

update_dashboard

update_dashboard(dashboard, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

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 Google Cloud IAM <https://cloud.google.com/iam>__.

.. rubric:: Example

from google.cloud.monitoring_dashboard import v1

client = v1.DashboardsServiceClient()

TODO: Initialize dashboard:

dashboard = {}

response = client.update_dashboard(dashboard)

Parameters

Name	Description
dashboard	Union[dict, Dashboard] Required. The dashboard that will replace the existing dashboard. If a dict is provided, it must be of the same form as the protobuf message Dashboard
retry	Optional[google.api_core.retry.Retry] A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout	Optional[float] The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata	Optional[Sequence[Tuple[str, str]]] Additional metadata that is provided to the method.

Exceptions

Type	Description
google.api_core.exceptions.GoogleAPICallError	If the request failed for any reason.
google.api_core.exceptions.RetryError	If the request failed due to a retryable error and retry attempts failed.
ValueError	If the parameters are invalid.