Summary of entries of Methods for essentialcontacts.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient
EssentialContactsServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport, typing.Callable[[...], google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport]]] = '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 essential contacts service async client.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.compute_contacts
compute_contacts(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.ComputeContactsRequest,
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.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsAsyncPager
)
Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.contact_path
contact_path(project: str, contact: str) -> str
Returns a fully-qualified contact string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.create_contact
create_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.CreateContactRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
contact: typing.Optional[
google.cloud.essential_contacts_v1.types.service.Contact
] = 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.essential_contacts_v1.types.service.Contact
Adds a new contact for a resource.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.delete_contact
delete_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.DeleteContactRequest, 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]] = ()
) -> None
Deletes a contact.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.get_contact
get_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.GetContactRequest, 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.essential_contacts_v1.types.service.Contact
Gets a single contact.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport
]
Returns an appropriate transport class.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.list_contacts
list_contacts(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.ListContactsRequest, 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, str]] = ()
) -> (
google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsAsyncPager
)
Lists the contacts that have been set on a resource.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.parse_contact_path
parse_contact_path(path: str) -> typing.Dict[str, str]
Parses a contact path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.send_test_message
send_test_message(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.SendTestMessageRequest,
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]] = ()
) -> None
Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceAsyncClient.update_contact
update_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.UpdateContactRequest, dict
]
] = None,
*,
contact: typing.Optional[
google.cloud.essential_contacts_v1.types.service.Contact
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.essential_contacts_v1.types.service.Contact
Updates a contact.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient
EssentialContactsServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport, typing.Callable[[...], google.cloud.essential_contacts_v1.services.essential_contacts_service.transports.base.EssentialContactsServiceTransport]]] = 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 essential contacts service client.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.compute_contacts
compute_contacts(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.ComputeContactsRequest,
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.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager
)
Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.contact_path
contact_path(project: str, contact: str) -> str
Returns a fully-qualified contact string.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.create_contact
create_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.CreateContactRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
contact: typing.Optional[
google.cloud.essential_contacts_v1.types.service.Contact
] = 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.essential_contacts_v1.types.service.Contact
Adds a new contact for a resource.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.delete_contact
delete_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.DeleteContactRequest, 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]] = ()
) -> None
Deletes a contact.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.get_contact
get_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.GetContactRequest, 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.essential_contacts_v1.types.service.Contact
Gets a single contact.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.list_contacts
list_contacts(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.ListContactsRequest, 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, str]] = ()
) -> (
google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager
)
Lists the contacts that have been set on a resource.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.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.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.parse_contact_path
parse_contact_path(path: str) -> typing.Dict[str, str]
Parses a contact path into its component segments.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.send_test_message
send_test_message(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.SendTestMessageRequest,
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]] = ()
) -> None
Allows a contact admin to send a test message to contact to verify that it has been configured correctly.
google.cloud.essential_contacts_v1.services.essential_contacts_service.EssentialContactsServiceClient.update_contact
update_contact(
request: typing.Optional[
typing.Union[
google.cloud.essential_contacts_v1.types.service.UpdateContactRequest, dict
]
] = None,
*,
contact: typing.Optional[
google.cloud.essential_contacts_v1.types.service.Contact
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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.essential_contacts_v1.types.service.Contact
Updates a contact.
google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsAsyncPager
ComputeContactsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.essential_contacts_v1.types.service.ComputeContactsResponse
],
],
request: google.cloud.essential_contacts_v1.types.service.ComputeContactsRequest,
response: google.cloud.essential_contacts_v1.types.service.ComputeContactsResponse,
*,
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]] = ()
)
Instantiates the pager.
google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager
ComputeContactsPager(
method: typing.Callable[
[...], google.cloud.essential_contacts_v1.types.service.ComputeContactsResponse
],
request: google.cloud.essential_contacts_v1.types.service.ComputeContactsRequest,
response: google.cloud.essential_contacts_v1.types.service.ComputeContactsResponse,
*,
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]] = ()
)
Instantiate the pager.
See more: google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ComputeContactsPager
google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsAsyncPager
ListContactsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.essential_contacts_v1.types.service.ListContactsResponse
],
],
request: google.cloud.essential_contacts_v1.types.service.ListContactsRequest,
response: google.cloud.essential_contacts_v1.types.service.ListContactsResponse,
*,
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]] = ()
)
Instantiates the pager.
See more: google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsAsyncPager
google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager
ListContactsPager(
method: typing.Callable[
[...], google.cloud.essential_contacts_v1.types.service.ListContactsResponse
],
request: google.cloud.essential_contacts_v1.types.service.ListContactsRequest,
response: google.cloud.essential_contacts_v1.types.service.ListContactsResponse,
*,
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]] = ()
)
Instantiate the pager.
See more: google.cloud.essential_contacts_v1.services.essential_contacts_service.pagers.ListContactsPager