Summary of entries of Methods for google-cloud-maintenance-api.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient
MaintenanceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.maintenance_api_v1beta.services.maintenance.transports.base.MaintenanceTransport, typing.Callable[[...], google.cloud.maintenance_api_v1beta.services.maintenance.transports.base.MaintenanceTransport]]] = '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 maintenance async client.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_folder_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_location_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.common_project_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.get_location
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.get_resource_maintenance
get_resource_maintenance(
request: typing.Optional[
typing.Union[
google.cloud.maintenance_api_v1beta.types.maintenance_service.GetResourceMaintenanceRequest,
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.maintenance_api_v1beta.types.maintenance_service.ResourceMaintenance
Retrieve a single resource maintenance.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.maintenance_api_v1beta.services.maintenance.transports.base.MaintenanceTransport
]
Returns an appropriate transport class.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.get_transport_class
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.list_locations
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.list_resource_maintenances
list_resource_maintenances(
request: typing.Optional[
typing.Union[
google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesRequest,
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.maintenance_api_v1beta.services.maintenance.pagers.ListResourceMaintenancesAsyncPager
)
Retrieve a collection of resource maintenances.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.parse_resource_maintenance_path
parse_resource_maintenance_path(path: str) -> typing.Dict[str, str]
Parses a resource_maintenance path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.resource_maintenance_path
resource_maintenance_path(
project: str, location: str, resource_maintenance: str
) -> str
Returns a fully-qualified resource_maintenance string.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceAsyncClient.summarize_maintenances
summarize_maintenances(
request: typing.Optional[
typing.Union[
google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesRequest,
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.maintenance_api_v1beta.services.maintenance.pagers.SummarizeMaintenancesAsyncPager
)
Retrieves the statistics of a specific maintenance.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient
MaintenanceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.maintenance_api_v1beta.services.maintenance.transports.base.MaintenanceTransport, typing.Callable[[...], google.cloud.maintenance_api_v1beta.services.maintenance.transports.base.MaintenanceTransport]]] = 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 maintenance client.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.exit
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_folder_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_location_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_organization_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.common_project_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceClient.from_service_account_file
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceClient.from_service_account_info
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceClient.from_service_account_json
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = 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.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.get_location
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceClient.get_resource_maintenance
get_resource_maintenance(
request: typing.Optional[
typing.Union[
google.cloud.maintenance_api_v1beta.types.maintenance_service.GetResourceMaintenanceRequest,
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.maintenance_api_v1beta.types.maintenance_service.ResourceMaintenance
Retrieve a single resource maintenance.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.get_resource_maintenance
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = 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.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.list_locations
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.list_resource_maintenances
list_resource_maintenances(
request: typing.Optional[
typing.Union[
google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesRequest,
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.maintenance_api_v1beta.services.maintenance.pagers.ListResourceMaintenancesPager
)
Retrieve a collection of resource maintenances.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceClient.parse_common_folder_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.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.maintenance_api_v1beta.services.maintenance.MaintenanceClient.parse_common_project_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.parse_resource_maintenance_path
parse_resource_maintenance_path(path: str) -> typing.Dict[str, str]
Parses a resource_maintenance path into its component segments.
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.resource_maintenance_path
resource_maintenance_path(
project: str, location: str, resource_maintenance: str
) -> str
Returns a fully-qualified resource_maintenance string.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.resource_maintenance_path
google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.summarize_maintenances
summarize_maintenances(
request: typing.Optional[
typing.Union[
google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesRequest,
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.maintenance_api_v1beta.services.maintenance.pagers.SummarizeMaintenancesPager
)
Retrieves the statistics of a specific maintenance.
See more: google.cloud.maintenance_api_v1beta.services.maintenance.MaintenanceClient.summarize_maintenances
google.cloud.maintenance_api_v1beta.services.maintenance.pagers.ListResourceMaintenancesAsyncPager
ListResourceMaintenancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesResponse
],
],
request: google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesRequest,
response: google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesResponse,
*,
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.maintenance_api_v1beta.services.maintenance.pagers.ListResourceMaintenancesAsyncPager
google.cloud.maintenance_api_v1beta.services.maintenance.pagers.ListResourceMaintenancesPager
ListResourceMaintenancesPager(
method: typing.Callable[
[...],
google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesResponse,
],
request: google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesRequest,
response: google.cloud.maintenance_api_v1beta.types.maintenance_service.ListResourceMaintenancesResponse,
*,
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.maintenance_api_v1beta.services.maintenance.pagers.ListResourceMaintenancesPager
google.cloud.maintenance_api_v1beta.services.maintenance.pagers.SummarizeMaintenancesAsyncPager
SummarizeMaintenancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesResponse
],
],
request: google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesRequest,
response: google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesResponse,
*,
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.maintenance_api_v1beta.services.maintenance.pagers.SummarizeMaintenancesAsyncPager
google.cloud.maintenance_api_v1beta.services.maintenance.pagers.SummarizeMaintenancesPager
SummarizeMaintenancesPager(
method: typing.Callable[
[...],
google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesResponse,
],
request: google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesRequest,
response: google.cloud.maintenance_api_v1beta.types.maintenance_service.SummarizeMaintenancesResponse,
*,
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.maintenance_api_v1beta.services.maintenance.pagers.SummarizeMaintenancesPager