Package Methods (1.7.0)

Summary of entries of Methods for google-cloud-monitoring-metrics-scopes.

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient

MetricsScopesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.transports.base.MetricsScopesTransport, typing.Callable[[...], google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.transports.base.MetricsScopesTransport]]] = '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 metrics scopes async client.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_billing_account_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_folder_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_location_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_organization_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.common_project_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.create_monitored_project

create_monitored_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.CreateMonitoredProjectRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    monitored_project: typing.Optional[
        google.cloud.monitoring_metrics_scope_v1.types.metrics_scope.MonitoredProject
    ] = 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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Adds a MonitoredProject with the given project ID to the specified Metrics Scope.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.create_monitored_project

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.delete_monitored_project

delete_monitored_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.DeleteMonitoredProjectRequest,
            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, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a MonitoredProject from the specified Metrics Scope.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.delete_monitored_project

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.from_service_account_file

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.from_service_account_info

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.from_service_account_json

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.get_metrics_scope

get_metrics_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.GetMetricsScopeRequest,
            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, str]] = ()
) -> google.cloud.monitoring_metrics_scope_v1.types.metrics_scope.MetricsScope

Returns a specific Metrics Scope.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.get_metrics_scope

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.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.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.transports.base.MetricsScopesTransport
]

Returns an appropriate transport class.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.get_transport_class

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.list_metrics_scopes_by_monitored_project

list_metrics_scopes_by_monitored_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.ListMetricsScopesByMonitoredProjectRequest,
            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, str]] = ()
) -> (
    google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.ListMetricsScopesByMonitoredProjectResponse
)

Returns a list of every Metrics Scope that a specific MonitoredProject has been added to.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.list_metrics_scopes_by_monitored_project

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.metrics_scope_path

metrics_scope_path(metrics_scope: str) -> str

Returns a fully-qualified metrics_scope string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.metrics_scope_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.monitored_project_path

monitored_project_path(metrics_scope: str, project: str) -> str

Returns a fully-qualified monitored_project string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.monitored_project_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.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.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_billing_account_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_folder_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_location_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_organization_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_common_project_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_metrics_scope_path

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

Parses a metrics_scope path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_metrics_scope_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_monitored_project_path

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

Parses a monitored_project path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesAsyncClient.parse_monitored_project_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient

MetricsScopesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.transports.base.MetricsScopesTransport, typing.Callable[[...], google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.transports.base.MetricsScopesTransport]]] = 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 metrics scopes client.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.exit

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_billing_account_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_folder_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_location_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_organization_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.common_project_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.create_monitored_project

create_monitored_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.CreateMonitoredProjectRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    monitored_project: typing.Optional[
        google.cloud.monitoring_metrics_scope_v1.types.metrics_scope.MonitoredProject
    ] = 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.api_core.operation.Operation

Adds a MonitoredProject with the given project ID to the specified Metrics Scope.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.create_monitored_project

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.delete_monitored_project

delete_monitored_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.DeleteMonitoredProjectRequest,
            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.api_core.operation.Operation

Deletes a MonitoredProject from the specified Metrics Scope.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.delete_monitored_project

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.from_service_account_file

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.from_service_account_info

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.from_service_account_json

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.get_metrics_scope

get_metrics_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.GetMetricsScopeRequest,
            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_metrics_scope_v1.types.metrics_scope.MetricsScope

Returns a specific Metrics Scope.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.get_metrics_scope

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.get_mtls_endpoint_and_cert_source

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.list_metrics_scopes_by_monitored_project

list_metrics_scopes_by_monitored_project(
    request: typing.Optional[
        typing.Union[
            google.cloud.monitoring_metrics_scope_v1.types.metrics_scopes.ListMetricsScopesByMonitoredProjectRequest,
            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_metrics_scope_v1.types.metrics_scopes.ListMetricsScopesByMonitoredProjectResponse
)

Returns a list of every Metrics Scope that a specific MonitoredProject has been added to.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.list_metrics_scopes_by_monitored_project

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.metrics_scope_path

metrics_scope_path(metrics_scope: str) -> str

Returns a fully-qualified metrics_scope string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.metrics_scope_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.monitored_project_path

monitored_project_path(metrics_scope: str, project: str) -> str

Returns a fully-qualified monitored_project string.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.monitored_project_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.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.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_billing_account_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_folder_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_location_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_organization_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_common_project_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_metrics_scope_path

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

Parses a metrics_scope path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_metrics_scope_path

google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_monitored_project_path

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

Parses a monitored_project path into its component segments.

See more: google.cloud.monitoring_metrics_scope_v1.services.metrics_scopes.MetricsScopesClient.parse_monitored_project_path