Package com.google.cloud.networkmanagement.v1 (1.28.0)

A client to Network Management API

The interfaces provided are listed below, along with usage samples.

ReachabilityServiceClient

Service Description: 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.

Sample for ReachabilityServiceClient:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.create()) {
   String name = "name3373707";
   ConnectivityTest response = reachabilityServiceClient.getConnectivityTest(name);
 }

Classes

AbortInfo

Details of the final state "abort" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.AbortInfo

AbortInfo.Builder

Details of the final state "abort" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.AbortInfo

AppEngineVersionInfo

For display only. Metadata associated with an App Engine version.

Protobuf type google.cloud.networkmanagement.v1.AppEngineVersionInfo

AppEngineVersionInfo.Builder

For display only. Metadata associated with an App Engine version.

Protobuf type google.cloud.networkmanagement.v1.AppEngineVersionInfo

CloudFunctionInfo

For display only. Metadata associated with a Cloud Function.

Protobuf type google.cloud.networkmanagement.v1.CloudFunctionInfo

CloudFunctionInfo.Builder

For display only. Metadata associated with a Cloud Function.

Protobuf type google.cloud.networkmanagement.v1.CloudFunctionInfo

CloudRunRevisionInfo

For display only. Metadata associated with a Cloud Run revision.

Protobuf type google.cloud.networkmanagement.v1.CloudRunRevisionInfo

CloudRunRevisionInfo.Builder

For display only. Metadata associated with a Cloud Run revision.

Protobuf type google.cloud.networkmanagement.v1.CloudRunRevisionInfo

CloudSQLInstanceInfo

For display only. Metadata associated with a Cloud SQL instance.

Protobuf type google.cloud.networkmanagement.v1.CloudSQLInstanceInfo

CloudSQLInstanceInfo.Builder

For display only. Metadata associated with a Cloud SQL instance.

Protobuf type google.cloud.networkmanagement.v1.CloudSQLInstanceInfo

ConnectivityTest

A Connectivity Test for a network reachability analysis.

Protobuf type google.cloud.networkmanagement.v1.ConnectivityTest

ConnectivityTest.Builder

A Connectivity Test for a network reachability analysis.

Protobuf type google.cloud.networkmanagement.v1.ConnectivityTest

CreateConnectivityTestRequest

Request for the CreateConnectivityTest method.

Protobuf type google.cloud.networkmanagement.v1.CreateConnectivityTestRequest

CreateConnectivityTestRequest.Builder

Request for the CreateConnectivityTest method.

Protobuf type google.cloud.networkmanagement.v1.CreateConnectivityTestRequest

DeleteConnectivityTestRequest

Request for the DeleteConnectivityTest method.

Protobuf type google.cloud.networkmanagement.v1.DeleteConnectivityTestRequest

DeleteConnectivityTestRequest.Builder

Request for the DeleteConnectivityTest method.

Protobuf type google.cloud.networkmanagement.v1.DeleteConnectivityTestRequest

DeliverInfo

Details of the final state "deliver" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.DeliverInfo

DeliverInfo.Builder

Details of the final state "deliver" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.DeliverInfo

DropInfo

Details of the final state "drop" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.DropInfo

DropInfo.Builder

Details of the final state "drop" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.DropInfo

Endpoint

Source or destination of the Connectivity Test.

Protobuf type google.cloud.networkmanagement.v1.Endpoint

Endpoint.AppEngineVersionEndpoint

Wrapper for the App Engine service version attributes.

Protobuf type google.cloud.networkmanagement.v1.Endpoint.AppEngineVersionEndpoint

Endpoint.AppEngineVersionEndpoint.Builder

Wrapper for the App Engine service version attributes.

Protobuf type google.cloud.networkmanagement.v1.Endpoint.AppEngineVersionEndpoint

Endpoint.Builder

Source or destination of the Connectivity Test.

Protobuf type google.cloud.networkmanagement.v1.Endpoint

Endpoint.CloudFunctionEndpoint

Wrapper for Cloud Function attributes.

Protobuf type google.cloud.networkmanagement.v1.Endpoint.CloudFunctionEndpoint

Endpoint.CloudFunctionEndpoint.Builder

Wrapper for Cloud Function attributes.

Protobuf type google.cloud.networkmanagement.v1.Endpoint.CloudFunctionEndpoint

Endpoint.CloudRunRevisionEndpoint

Wrapper for Cloud Run revision attributes.

Protobuf type google.cloud.networkmanagement.v1.Endpoint.CloudRunRevisionEndpoint

Endpoint.CloudRunRevisionEndpoint.Builder

Wrapper for Cloud Run revision attributes.

Protobuf type google.cloud.networkmanagement.v1.Endpoint.CloudRunRevisionEndpoint

EndpointInfo

For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model.

Protobuf type google.cloud.networkmanagement.v1.EndpointInfo

EndpointInfo.Builder

For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model.

Protobuf type google.cloud.networkmanagement.v1.EndpointInfo

FirewallInfo

For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule.

Protobuf type google.cloud.networkmanagement.v1.FirewallInfo

FirewallInfo.Builder

For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule.

Protobuf type google.cloud.networkmanagement.v1.FirewallInfo

ForwardInfo

Details of the final state "forward" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.ForwardInfo

ForwardInfo.Builder

Details of the final state "forward" and associated resource.

Protobuf type google.cloud.networkmanagement.v1.ForwardInfo

ForwardingRuleInfo

For display only. Metadata associated with a Compute Engine forwarding rule.

Protobuf type google.cloud.networkmanagement.v1.ForwardingRuleInfo

ForwardingRuleInfo.Builder

For display only. Metadata associated with a Compute Engine forwarding rule.

Protobuf type google.cloud.networkmanagement.v1.ForwardingRuleInfo

GKEMasterInfo

For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master.

Protobuf type google.cloud.networkmanagement.v1.GKEMasterInfo

GKEMasterInfo.Builder

For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master.

Protobuf type google.cloud.networkmanagement.v1.GKEMasterInfo

GetConnectivityTestRequest

Request for the GetConnectivityTest method.

Protobuf type google.cloud.networkmanagement.v1.GetConnectivityTestRequest

GetConnectivityTestRequest.Builder

Request for the GetConnectivityTest method.

Protobuf type google.cloud.networkmanagement.v1.GetConnectivityTestRequest

GoogleServiceInfo

For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths

Protobuf type google.cloud.networkmanagement.v1.GoogleServiceInfo

GoogleServiceInfo.Builder

Protobuf type google.cloud.networkmanagement.v1.GoogleServiceInfo

InstanceInfo

For display only. Metadata associated with a Compute Engine instance.

Protobuf type google.cloud.networkmanagement.v1.InstanceInfo

InstanceInfo.Builder

For display only. Metadata associated with a Compute Engine instance.

Protobuf type google.cloud.networkmanagement.v1.InstanceInfo

LatencyDistribution

Describes measured latency distribution.

Protobuf type google.cloud.networkmanagement.v1.LatencyDistribution

LatencyDistribution.Builder

Describes measured latency distribution.

Protobuf type google.cloud.networkmanagement.v1.LatencyDistribution

LatencyPercentile

Latency percentile rank and value.

Protobuf type google.cloud.networkmanagement.v1.LatencyPercentile

LatencyPercentile.Builder

Latency percentile rank and value.

Protobuf type google.cloud.networkmanagement.v1.LatencyPercentile

ListConnectivityTestsRequest

Request for the ListConnectivityTests method.

Protobuf type google.cloud.networkmanagement.v1.ListConnectivityTestsRequest

ListConnectivityTestsRequest.Builder

Request for the ListConnectivityTests method.

Protobuf type google.cloud.networkmanagement.v1.ListConnectivityTestsRequest

ListConnectivityTestsResponse

Response for the ListConnectivityTests method.

Protobuf type google.cloud.networkmanagement.v1.ListConnectivityTestsResponse

ListConnectivityTestsResponse.Builder

Response for the ListConnectivityTests method.

Protobuf type google.cloud.networkmanagement.v1.ListConnectivityTestsResponse

LoadBalancerBackend

For display only. Metadata associated with a specific load balancer backend.

Protobuf type google.cloud.networkmanagement.v1.LoadBalancerBackend

LoadBalancerBackend.Builder

For display only. Metadata associated with a specific load balancer backend.

Protobuf type google.cloud.networkmanagement.v1.LoadBalancerBackend

LoadBalancerInfo

For display only. Metadata associated with a load balancer.

Protobuf type google.cloud.networkmanagement.v1.LoadBalancerInfo

LoadBalancerInfo.Builder

For display only. Metadata associated with a load balancer.

Protobuf type google.cloud.networkmanagement.v1.LoadBalancerInfo

NetworkInfo

For display only. Metadata associated with a Compute Engine network.

Protobuf type google.cloud.networkmanagement.v1.NetworkInfo

NetworkInfo.Builder

For display only. Metadata associated with a Compute Engine network.

Protobuf type google.cloud.networkmanagement.v1.NetworkInfo

OperationMetadata

Metadata describing an Operation

Protobuf type google.cloud.networkmanagement.v1.OperationMetadata

OperationMetadata.Builder

Metadata describing an Operation

Protobuf type google.cloud.networkmanagement.v1.OperationMetadata

ProbingDetails

Results of active probing from the last run of the test.

Protobuf type google.cloud.networkmanagement.v1.ProbingDetails

ProbingDetails.Builder

Results of active probing from the last run of the test.

Protobuf type google.cloud.networkmanagement.v1.ProbingDetails

ProbingDetails.EdgeLocation

Representation of a network edge location as per https://cloud.google.com/vpc/docs/edge-locations.

Protobuf type google.cloud.networkmanagement.v1.ProbingDetails.EdgeLocation

ProbingDetails.EdgeLocation.Builder

Representation of a network edge location as per https://cloud.google.com/vpc/docs/edge-locations.

Protobuf type google.cloud.networkmanagement.v1.ProbingDetails.EdgeLocation

ReachabilityDetails

Results of the configuration analysis from the last run of the test.

Protobuf type google.cloud.networkmanagement.v1.ReachabilityDetails

ReachabilityDetails.Builder

Results of the configuration analysis from the last run of the test.

Protobuf type google.cloud.networkmanagement.v1.ReachabilityDetails

ReachabilityServiceClient

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.create()) {
   String name = "name3373707";
   ConnectivityTest response = reachabilityServiceClient.getConnectivityTest(name);
 }

Note: close() needs to be called on the ReachabilityServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ReachabilityServiceSettings to create(). For example:

To customize credentials:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ReachabilityServiceSettings reachabilityServiceSettings =
     ReachabilityServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReachabilityServiceClient reachabilityServiceClient =
     ReachabilityServiceClient.create(reachabilityServiceSettings);

To customize the endpoint:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ReachabilityServiceSettings reachabilityServiceSettings =
     ReachabilityServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReachabilityServiceClient reachabilityServiceClient =
     ReachabilityServiceClient.create(reachabilityServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ReachabilityServiceSettings reachabilityServiceSettings =
     ReachabilityServiceSettings.newHttpJsonBuilder().build();
 ReachabilityServiceClient reachabilityServiceClient =
     ReachabilityServiceClient.create(reachabilityServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ReachabilityServiceClient.ListConnectivityTestsFixedSizeCollection

ReachabilityServiceClient.ListConnectivityTestsPage

ReachabilityServiceClient.ListConnectivityTestsPagedResponse

ReachabilityServiceGrpc

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.

ReachabilityServiceGrpc.ReachabilityServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service ReachabilityService.

ReachabilityServiceGrpc.ReachabilityServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service ReachabilityService.

ReachabilityServiceGrpc.ReachabilityServiceImplBase

Base class for the server implementation of the service ReachabilityService.

ReachabilityServiceGrpc.ReachabilityServiceStub

A stub to allow clients to do asynchronous rpc calls to service ReachabilityService.

ReachabilityServiceProto

ReachabilityServiceSettings

Settings class to configure an instance of ReachabilityServiceClient.

The default instance has everything set to sensible defaults:

The default service address (networkmanagement.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getConnectivityTest to 30 seconds:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ReachabilityServiceSettings.Builder reachabilityServiceSettingsBuilder =
     ReachabilityServiceSettings.newBuilder();
 reachabilityServiceSettingsBuilder
     .getConnectivityTestSettings()
     .setRetrySettings(
         reachabilityServiceSettingsBuilder
             .getConnectivityTestSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ReachabilityServiceSettings reachabilityServiceSettings =
     reachabilityServiceSettingsBuilder.build();

Each trace contains multiple ordered steps.
Each step is in a particular state with associated configuration.
State is categorized as final or non-final states.
Each final state has a reason associated.
Each trace must end with a final state (the last step). <code><code> |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) </code></code>

Protobuf type google.cloud.networkmanagement.v1.Trace

Trace.Builder

Trace represents one simulated packet forwarding path.

Each trace contains multiple ordered steps.
Each step is in a particular state with associated configuration.
State is categorized as final or non-final states.
Each final state has a reason associated.
Each trace must end with a final state (the last step). <code><code> |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) </code></code>

Protobuf type google.cloud.networkmanagement.v1.Trace

Package com.google.cloud.networkmanagement.v1 (1.28.0)

ReachabilityServiceClient

Classes

Interfaces

Enums