Package Methods (2.19.0)
Stay organized with collections
Save and categorize content based on your preferences.
Summary of entries of Methods for monitoring-dashboards.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient
DashboardsServiceAsyncClient(*, 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]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = Instantiates the dashboards service async client.
See more: google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.alert_policy_path
alert_policy_path(project: str, alert_policy: str) -> strReturns a fully-qualified alert_policy string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.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_async.AsyncRetry,
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.monitoring_dashboard_v1.types.dashboard.DashboardCreates a new custom dashboard.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.dashboard_path
dashboard_path(project: str, dashboard: str) -> strReturns a fully-qualified dashboard string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.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_async.AsyncRetry,
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]]] = ()
) -> NoneDeletes an existing custom dashboard.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.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_async.AsyncRetry,
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.monitoring_dashboard_v1.types.dashboard.DashboardFetches a specific dashboard.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)Return the API endpoint and client cert source for mutual TLS.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.monitoring_dashboard_v1.services.dashboards_service.transports.base.DashboardsServiceTransport
]Returns an appropriate transport class.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.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_async.AsyncRetry,
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.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsAsyncPager
)Lists the existing dashboards.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.parse_alert_policy_path
parse_alert_policy_path(path: str) -> typing.Dict[str, str]Parses a alert_policy path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.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.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.parse_dashboard_path
parse_dashboard_path(path: str) -> typing.Dict[str, str]Parses a dashboard path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceAsyncClient.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_async.AsyncRetry,
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.monitoring_dashboard_v1.types.dashboard.DashboardReplaces an existing custom dashboard with a new definition.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.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 = Instantiates the dashboards service client.
See more: google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
See more: google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.exit
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.alert_policy_path
alert_policy_path(project: str, alert_policy: str) -> strReturns a fully-qualified alert_policy string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.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, typing.Union[str, bytes]]] = ()
) -> google.cloud.monitoring_dashboard_v1.types.dashboard.DashboardCreates a new custom dashboard.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.dashboard_path
dashboard_path(project: str, dashboard: str) -> strReturns a fully-qualified dashboard string.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.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, typing.Union[str, bytes]]] = ()
) -> NoneDeletes an existing custom dashboard.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.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, typing.Union[str, bytes]]] = ()
) -> google.cloud.monitoring_dashboard_v1.types.dashboard.DashboardFetches a specific dashboard.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)Deprecated.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.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, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsPager
)Lists the existing dashboards.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.parse_alert_policy_path
parse_alert_policy_path(path: str) -> typing.Dict[str, str]Parses a alert_policy path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.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.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.parse_dashboard_path
parse_dashboard_path(path: str) -> typing.Dict[str, str]Parses a dashboard path into its component segments.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.DashboardsServiceClient.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, typing.Union[str, bytes]]] = ()
) -> google.cloud.monitoring_dashboard_v1.types.dashboard.DashboardReplaces an existing custom dashboard with a new definition.
google.cloud.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsAsyncPager
ListDashboardsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse
],
],
request: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsRequest,
response: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
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]]] = ()
)Instantiates the pager.
See more: google.cloud.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsAsyncPager
google.cloud.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsPager
ListDashboardsPager(
method: typing.Callable[
[...],
google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse,
],
request: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsRequest,
response: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse,
*,
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]]] = ()
)Instantiate the pager.
See more: google.cloud.monitoring_dashboard_v1.services.dashboards_service.pagers.ListDashboardsPager