DashboardsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_dashboard_v1.services.dashboards_service.transports.base.DashboardsServiceTransport]] = None, client_options: Optional[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
transport
Returns the transport used by the client instance.
Type | Description |
DashboardsServiceTransport | The transport used by the client instance. |
Methods
DashboardsServiceClient
DashboardsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.monitoring_dashboard_v1.services.dashboards_service.transports.base.DashboardsServiceTransport]] = None, client_options: Optional[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.
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 |
Union[str, DashboardsServiceTransport]
The transport to use. 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. It won't take effect if a |
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 |
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)
Returns a fully-qualified alert_policy string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_dashboard
create_dashboard(request: Optional[Union[google.cloud.monitoring_dashboard_v1.types.dashboards_service.CreateDashboardRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
Name | Description |
request |
Union[google.cloud.monitoring_dashboard_v1.types.CreateDashboardRequest, dict]
The request object. The |
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. |
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)
Returns a fully-qualified dashboard string.
delete_dashboard
delete_dashboard(request: Optional[Union[google.cloud.monitoring_dashboard_v1.types.dashboards_service.DeleteDashboardRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
Name | Description |
request |
Union[google.cloud.monitoring_dashboard_v1.types.DeleteDashboardRequest, dict]
The request object. The |
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
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.
Name | Description |
info |
dict
The service account private key info. |
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
DashboardsServiceClient | The constructed client. |
get_dashboard
get_dashboard(request: Optional[Union[google.cloud.monitoring_dashboard_v1.types.dashboards_service.GetDashboardRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
Name | Description |
request |
Union[google.cloud.monitoring_dashboard_v1.types.GetDashboardRequest, dict]
The request object. The |
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. |
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: Optional[google.api_core.client_options.ClientOptions] = None,
)
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.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
list_dashboards
list_dashboards(request: Optional[Union[google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
Name | Description |
request |
Union[google.cloud.monitoring_dashboard_v1.types.ListDashboardsRequest, dict]
The request object. The |
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. |
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)
Parses a alert_policy path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_dashboard_path
parse_dashboard_path(path: str)
Parses a dashboard path into its component segments.
update_dashboard
update_dashboard(request: Optional[Union[google.cloud.monitoring_dashboard_v1.types.dashboards_service.UpdateDashboardRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
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)
Name | Description |
request |
Union[google.cloud.monitoring_dashboard_v1.types.UpdateDashboardRequest, dict]
The request object. The |
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. |
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. |