Class ReachabilityServiceAsyncClient (1.5.3)

ReachabilityServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.network_management_v1.services.reachability_service.transports.base.ReachabilityServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

Inheritance

builtins.object > ReachabilityServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
ReachabilityServiceTransport	The transport used by the client instance.

Methods

ReachabilityServiceAsyncClient

ReachabilityServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.network_management_v1.services.reachability_service.transports.base.ReachabilityServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the reachability service client.

Parameters

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, `.ReachabilityServiceTransport`] The transport to use. If set to None, a transport is chosen automatically.
client_options	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

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.

connectivity_test_path

connectivity_test_path(project: str, test: str)

Returns a fully-qualified connectivity_test string.

create_connectivity_test

create_connectivity_test(request: Optional[Union[google.cloud.network_management_v1.types.reachability.CreateConnectivityTestRequest, dict]] = None, *, parent: Optional[str] = None, test_id: Optional[str] = None, resource: Optional[google.cloud.network_management_v1.types.connectivity_test.ConnectivityTest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.

If the endpoint specifications in ConnectivityTest are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.

# 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 network_management_v1

async def sample_create_connectivity_test():
    # Create a client
    client = network_management_v1.ReachabilityServiceAsyncClient()

    # Initialize request argument(s)
    resource = network_management_v1.ConnectivityTest()
    resource.name = "name_value"

    request = network_management_v1.CreateConnectivityTestRequest(
        parent="parent_value",
        test_id="test_id_value",
        resource=resource,
    )

    # Make the request
    operation = client.create_connectivity_test(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.network_management_v1.types.CreateConnectivityTestRequest, dict]` The request object. Request for the `CreateConnectivityTest` method.
parent	`str` Required. The parent resource of the Connectivity Test to create: `projects/{project_id}/locations/global` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
test_id	`str` Required. The logical name of the Connectivity Test in your project with the following restrictions: - Must contain only lowercase letters, numbers, and hyphens. - Must start with a letter. - Must be between 1-40 characters. - Must end with a number or a letter. - Must be unique within the customer project This corresponds to the `test_id` field on the `request` instance; if `request` is provided, this should not be set.
resource	`ConnectivityTest` Required. A `ConnectivityTest` resource This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be ConnectivityTest A Connectivity Test for a network reachability analysis.

delete_connectivity_test

delete_connectivity_test(request: Optional[Union[google.cloud.network_management_v1.types.reachability.DeleteConnectivityTestRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a specific ConnectivityTest.

# 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 network_management_v1

async def sample_delete_connectivity_test():
    # Create a client
    client = network_management_v1.ReachabilityServiceAsyncClient()

    # Initialize request argument(s)
    request = network_management_v1.DeleteConnectivityTestRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_connectivity_test(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.network_management_v1.types.DeleteConnectivityTestRequest, dict]` The request object. Request for the `DeleteConnectivityTest` method.
name	`str` Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type

Description

google.api_core.operation_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

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

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

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
ReachabilityServiceAsyncClient	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.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
ReachabilityServiceAsyncClient	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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
ReachabilityServiceAsyncClient	The constructed client.

get_connectivity_test

get_connectivity_test(request: Optional[Union[google.cloud.network_management_v1.types.reachability.GetConnectivityTestRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the details of a specific Connectivity Test.

# 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 network_management_v1

async def sample_get_connectivity_test():
    # Create a client
    client = network_management_v1.ReachabilityServiceAsyncClient()

    # Initialize request argument(s)
    request = network_management_v1.GetConnectivityTestRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_connectivity_test(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.network_management_v1.types.GetConnectivityTestRequest, dict]` The request object. Request for the `GetConnectivityTest` method.
name	`str` Required. `ConnectivityTest` resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.cloud.network_management_v1.types.ConnectivityTest	A Connectivity Test for a network reachability analysis.

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 variabel 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.

Parameter

Name	Description
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_connectivity_tests

list_connectivity_tests(request: Optional[Union[google.cloud.network_management_v1.types.reachability.ListConnectivityTestsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all Connectivity Tests owned by a project.

# 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 network_management_v1

async def sample_list_connectivity_tests():
    # Create a client
    client = network_management_v1.ReachabilityServiceAsyncClient()

    # Initialize request argument(s)
    request = network_management_v1.ListConnectivityTestsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_connectivity_tests(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.network_management_v1.types.ListConnectivityTestsRequest, dict]` The request object. Request for the `ListConnectivityTests` method.
parent	`str` Required. The parent resource of the Connectivity Tests: `projects/{project_id}/locations/global` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.cloud.network_management_v1.services.reachability_service.pagers.ListConnectivityTestsAsyncPager	Response for the ListConnectivityTests method. Iterating over this object will yield results and resolve additional pages automatically.

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_connectivity_test_path

parse_connectivity_test_path(path: str)

Parses a connectivity_test path into its component segments.

rerun_connectivity_test

rerun_connectivity_test(request: Optional[Union[google.cloud.network_management_v1.types.reachability.RerunConnectivityTestRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Rerun an existing ConnectivityTest. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.

Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes.

If the endpoint specifications in ConnectivityTest become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

# 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 network_management_v1

async def sample_rerun_connectivity_test():
    # Create a client
    client = network_management_v1.ReachabilityServiceAsyncClient()

    # Initialize request argument(s)
    request = network_management_v1.RerunConnectivityTestRequest(
        name="name_value",
    )

    # Make the request
    operation = client.rerun_connectivity_test(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.network_management_v1.types.RerunConnectivityTestRequest, dict]` The request object. Request for the `RerunConnectivityTest` method.
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.

Returns

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be ConnectivityTest A Connectivity Test for a network reachability analysis.

update_connectivity_test

update_connectivity_test(request: Optional[Union[google.cloud.network_management_v1.types.reachability.UpdateConnectivityTestRequest, dict]] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, resource: Optional[google.cloud.network_management_v1.types.connectivity_test.ConnectivityTest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the configuration of an existing ConnectivityTest. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result.

If the endpoint specifications in ConnectivityTest are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.

If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. See the documentation in ConnectivityTest for for more details.

# 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 network_management_v1

async def sample_update_connectivity_test():
    # Create a client
    client = network_management_v1.ReachabilityServiceAsyncClient()

    # Initialize request argument(s)
    resource = network_management_v1.ConnectivityTest()
    resource.name = "name_value"

    request = network_management_v1.UpdateConnectivityTestRequest(
        resource=resource,
    )

    # Make the request
    operation = client.update_connectivity_test(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.network_management_v1.types.UpdateConnectivityTestRequest, dict]` The request object. Request for the `UpdateConnectivityTest` method.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Required. Mask of fields to update. At least one path must be supplied in this field. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
resource	`ConnectivityTest` Required. Only fields specified in update_mask are updated. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
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.

Returns

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be ConnectivityTest A Connectivity Test for a network reachability analysis.