As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ReachabilityService

class google.cloud.network_management_v1.services.reachability_service.ReachabilityServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.network_management_v1.services.reachability_service.transports.base.ReachabilityServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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.

Instantiates the reachability service client.

Parameters
  • 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.

Raises

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

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

static connectivity_test_path(project: str, test: str)str

Returns a fully-qualified connectivity_test string.

async create_connectivity_test(request: Optional[google.cloud.network_management_v1.types.reachability.CreateConnectivityTestRequest] = None, *, parent: Optional[str] = None, test_id: Optional[str] = None, resource: Optional[google.cloud.network_management_v1.types.connectivity_test.ConnectivityTest] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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.

Parameters
  • request (google.cloud.network_management_v1.types.CreateConnectivityTestRequest) – 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 (google.cloud.network_management_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_management_v1.types.ConnectivityTest A Connectivity Test for a network reachability analysis.

Return type

google.api_core.operation_async.AsyncOperation

async delete_connectivity_test(request: Optional[google.cloud.network_management_v1.types.reachability.DeleteConnectivityTestRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Deletes a specific ConnectivityTest.

Parameters
  • request (google.cloud.network_management_v1.types.DeleteConnectivityTestRequest) – 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

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);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ReachabilityServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ReachabilityServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ReachabilityServiceAsyncClient

async get_connectivity_test(request: Optional[google.cloud.network_management_v1.types.reachability.GetConnectivityTestRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.network_management_v1.types.connectivity_test.ConnectivityTest[source]

Gets the details of a specific Connectivity Test.

Parameters
  • request (google.cloud.network_management_v1.types.GetConnectivityTestRequest) – 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

A Connectivity Test for a network reachability analysis.

Return type

google.cloud.network_management_v1.types.ConnectivityTest

get_transport_class()Type[google.cloud.network_management_v1.services.reachability_service.transports.base.ReachabilityServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_connectivity_tests(request: Optional[google.cloud.network_management_v1.types.reachability.ListConnectivityTestsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.network_management_v1.services.reachability_service.pagers.ListConnectivityTestsAsyncPager[source]

Lists all Connectivity Tests owned by a project.

Parameters
  • request (google.cloud.network_management_v1.types.ListConnectivityTestsRequest) – 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

Response for the ListConnectivityTests method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_management_v1.services.reachability_service.pagers.ListConnectivityTestsAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_connectivity_test_path(path: str)Dict[str, str]

Parses a connectivity_test path into its component segments.

async rerun_connectivity_test(request: Optional[google.cloud.network_management_v1.types.reachability.RerunConnectivityTestRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_management_v1.types.ConnectivityTest A Connectivity Test for a network reachability analysis.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.network_management_v1.services.reachability_service.transports.base.ReachabilityServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ReachabilityServiceTransport

async update_connectivity_test(request: Optional[google.cloud.network_management_v1.types.reachability.UpdateConnectivityTestRequest] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, resource: Optional[google.cloud.network_management_v1.types.connectivity_test.ConnectivityTest] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_management_v1.types.ConnectivityTest A Connectivity Test for a network reachability analysis.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.network_management_v1.services.reachability_service.ReachabilityServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.network_management_v1.services.reachability_service.transports.base.ReachabilityServiceTransport]] = None, 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>)[source]

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.

Instantiates the reachability service client.

Parameters
  • 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 (google.api_core.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.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

static connectivity_test_path(project: str, test: str)str[source]

Returns a fully-qualified connectivity_test string.

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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.

Parameters
  • 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 (google.cloud.network_management_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_management_v1.types.ConnectivityTest A Connectivity Test for a network reachability analysis.

Return type

google.api_core.operation.Operation

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

Deletes a specific ConnectivityTest.

Parameters
  • 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

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);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ReachabilityServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ReachabilityServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ReachabilityServiceClient

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

Gets the details of a specific Connectivity Test.

Parameters
  • 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

A Connectivity Test for a network reachability analysis.

Return type

google.cloud.network_management_v1.types.ConnectivityTest

list_connectivity_tests(request: Optional[Union[google.cloud.network_management_v1.types.reachability.ListConnectivityTestsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.network_management_v1.services.reachability_service.pagers.ListConnectivityTestsPager[source]

Lists all Connectivity Tests owned by a project.

Parameters
  • 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

Response for the ListConnectivityTests method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_management_v1.services.reachability_service.pagers.ListConnectivityTestsPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_connectivity_test_path(path: str)Dict[str, str][source]

Parses a connectivity_test path into its component segments.

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

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.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_management_v1.types.ConnectivityTest A Connectivity Test for a network reachability analysis.

Return type

google.api_core.operation.Operation

property transport: google.cloud.network_management_v1.services.reachability_service.transports.base.ReachabilityServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ReachabilityServiceTransport

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: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_management_v1.types.ConnectivityTest A Connectivity Test for a network reachability analysis.

Return type

google.api_core.operation.Operation

class google.cloud.network_management_v1.services.reachability_service.pagers.ListConnectivityTestsAsyncPager(method: Callable[[...], Awaitable[google.cloud.network_management_v1.types.reachability.ListConnectivityTestsResponse]], request: google.cloud.network_management_v1.types.reachability.ListConnectivityTestsRequest, response: google.cloud.network_management_v1.types.reachability.ListConnectivityTestsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_connectivity_tests requests.

This class thinly wraps an initial google.cloud.network_management_v1.types.ListConnectivityTestsResponse object, and provides an __aiter__ method to iterate through its resources field.

If there are more pages, the __aiter__ method will make additional ListConnectivityTests requests and continue to iterate through the resources field on the corresponding responses.

All the usual google.cloud.network_management_v1.types.ListConnectivityTestsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.network_management_v1.services.reachability_service.pagers.ListConnectivityTestsPager(method: Callable[[...], google.cloud.network_management_v1.types.reachability.ListConnectivityTestsResponse], request: google.cloud.network_management_v1.types.reachability.ListConnectivityTestsRequest, response: google.cloud.network_management_v1.types.reachability.ListConnectivityTestsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_connectivity_tests requests.

This class thinly wraps an initial google.cloud.network_management_v1.types.ListConnectivityTestsResponse object, and provides an __iter__ method to iterate through its resources field.

If there are more pages, the __iter__ method will make additional ListConnectivityTests requests and continue to iterate through the resources field on the corresponding responses.

All the usual google.cloud.network_management_v1.types.ListConnectivityTestsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters