- 1.54.0 (latest)
- 1.53.0
- 1.52.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.1.10
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:
try (ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.create()) {
GetConnectivityTestRequest request =
GetConnectivityTestRequest.newBuilder().setName("name3373707").build();
ConnectivityTest response = reachabilityServiceClient.getConnectivityTest(request);
}
Classes
AbortInfo
Details of the final state "abort" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.AbortInfo
AbortInfo.Builder
Details of the final state "abort" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.AbortInfo
CloudSQLInstanceInfo
For display only. Metadata associated with a Cloud SQL instance.
Protobuf type google.cloud.networkmanagement.v1beta1.CloudSQLInstanceInfo
CloudSQLInstanceInfo.Builder
For display only. Metadata associated with a Cloud SQL instance.
Protobuf type google.cloud.networkmanagement.v1beta1.CloudSQLInstanceInfo
ConnectivityTest
A Connectivity Test for a network reachability analysis.
Protobuf type google.cloud.networkmanagement.v1beta1.ConnectivityTest
ConnectivityTest.Builder
A Connectivity Test for a network reachability analysis.
Protobuf type google.cloud.networkmanagement.v1beta1.ConnectivityTest
CreateConnectivityTestRequest
Request for the CreateConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.CreateConnectivityTestRequest
CreateConnectivityTestRequest.Builder
Request for the CreateConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.CreateConnectivityTestRequest
DeleteConnectivityTestRequest
Request for the DeleteConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.DeleteConnectivityTestRequest
DeleteConnectivityTestRequest.Builder
Request for the DeleteConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.DeleteConnectivityTestRequest
DeliverInfo
Details of the final state "deliver" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.DeliverInfo
DeliverInfo.Builder
Details of the final state "deliver" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.DeliverInfo
DropInfo
Details of the final state "drop" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.DropInfo
DropInfo.Builder
Details of the final state "drop" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.DropInfo
Endpoint
Source or destination of the Connectivity Test.
Protobuf type google.cloud.networkmanagement.v1beta1.Endpoint
Endpoint.Builder
Source or destination of the Connectivity Test.
Protobuf type google.cloud.networkmanagement.v1beta1.Endpoint
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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.FirewallInfo
ForwardInfo
Details of the final state "forward" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.ForwardInfo
ForwardInfo.Builder
Details of the final state "forward" and associated resource.
Protobuf type google.cloud.networkmanagement.v1beta1.ForwardInfo
ForwardingRuleInfo
For display only. Metadata associated with a Compute Engine forwarding rule.
Protobuf type google.cloud.networkmanagement.v1beta1.ForwardingRuleInfo
ForwardingRuleInfo.Builder
For display only. Metadata associated with a Compute Engine forwarding rule.
Protobuf type google.cloud.networkmanagement.v1beta1.ForwardingRuleInfo
GKEMasterInfo
For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master.
Protobuf type google.cloud.networkmanagement.v1beta1.GKEMasterInfo
GKEMasterInfo.Builder
For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master.
Protobuf type google.cloud.networkmanagement.v1beta1.GKEMasterInfo
GetConnectivityTestRequest
Request for the GetConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.GetConnectivityTestRequest
GetConnectivityTestRequest.Builder
Request for the GetConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.GetConnectivityTestRequest
InstanceInfo
For display only. Metadata associated with a Compute Engine instance.
Protobuf type google.cloud.networkmanagement.v1beta1.InstanceInfo
InstanceInfo.Builder
For display only. Metadata associated with a Compute Engine instance.
Protobuf type google.cloud.networkmanagement.v1beta1.InstanceInfo
LatencyDistribution
Describes measured latency distribution.
Protobuf type google.cloud.networkmanagement.v1beta1.LatencyDistribution
LatencyDistribution.Builder
Describes measured latency distribution.
Protobuf type google.cloud.networkmanagement.v1beta1.LatencyDistribution
LatencyPercentile
Latency percentile rank and value.
Protobuf type google.cloud.networkmanagement.v1beta1.LatencyPercentile
LatencyPercentile.Builder
Latency percentile rank and value.
Protobuf type google.cloud.networkmanagement.v1beta1.LatencyPercentile
ListConnectivityTestsRequest
Request for the ListConnectivityTests
method.
Protobuf type google.cloud.networkmanagement.v1beta1.ListConnectivityTestsRequest
ListConnectivityTestsRequest.Builder
Request for the ListConnectivityTests
method.
Protobuf type google.cloud.networkmanagement.v1beta1.ListConnectivityTestsRequest
ListConnectivityTestsResponse
Response for the ListConnectivityTests
method.
Protobuf type google.cloud.networkmanagement.v1beta1.ListConnectivityTestsResponse
ListConnectivityTestsResponse.Builder
Response for the ListConnectivityTests
method.
Protobuf type google.cloud.networkmanagement.v1beta1.ListConnectivityTestsResponse
LoadBalancerBackend
For display only. Metadata associated with a specific load balancer backend.
Protobuf type google.cloud.networkmanagement.v1beta1.LoadBalancerBackend
LoadBalancerBackend.Builder
For display only. Metadata associated with a specific load balancer backend.
Protobuf type google.cloud.networkmanagement.v1beta1.LoadBalancerBackend
LoadBalancerInfo
For display only. Metadata associated with a load balancer.
Protobuf type google.cloud.networkmanagement.v1beta1.LoadBalancerInfo
LoadBalancerInfo.Builder
For display only. Metadata associated with a load balancer.
Protobuf type google.cloud.networkmanagement.v1beta1.LoadBalancerInfo
NetworkInfo
For display only. Metadata associated with a Compute Engine network.
Protobuf type google.cloud.networkmanagement.v1beta1.NetworkInfo
NetworkInfo.Builder
For display only. Metadata associated with a Compute Engine network.
Protobuf type google.cloud.networkmanagement.v1beta1.NetworkInfo
OperationMetadata
Metadata describing an Operation
Protobuf type google.cloud.networkmanagement.v1beta1.OperationMetadata
OperationMetadata.Builder
Metadata describing an Operation
Protobuf type google.cloud.networkmanagement.v1beta1.OperationMetadata
ProbingDetails
Results of active probing from the last run of the test.
Protobuf type google.cloud.networkmanagement.v1beta1.ProbingDetails
ProbingDetails.Builder
Results of active probing from the last run of the test.
Protobuf type google.cloud.networkmanagement.v1beta1.ProbingDetails
ReachabilityDetails
Results of the configuration analysis from the last run of the test.
Protobuf type google.cloud.networkmanagement.v1beta1.ReachabilityDetails
ReachabilityDetails.Builder
Results of the configuration analysis from the last run of the test.
Protobuf type google.cloud.networkmanagement.v1beta1.ReachabilityDetails
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.
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:
try (ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.create()) {
GetConnectivityTestRequest request =
GetConnectivityTestRequest.newBuilder().setName("name3373707").build();
ConnectivityTest response = reachabilityServiceClient.getConnectivityTest(request);
}
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:
ReachabilityServiceSettings reachabilityServiceSettings =
ReachabilityServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ReachabilityServiceClient reachabilityServiceClient =
ReachabilityServiceClient.create(reachabilityServiceSettings);
To customize the endpoint:
ReachabilityServiceSettings reachabilityServiceSettings =
ReachabilityServiceSettings.newBuilder().setEndpoint(myEndpoint).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
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.ReachabilityServiceFutureStub
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.ReachabilityServiceImplBase
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.ReachabilityServiceStub
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.
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:
ReachabilityServiceSettings.Builder reachabilityServiceSettingsBuilder =
ReachabilityServiceSettings.newBuilder();
reachabilityServiceSettingsBuilder
.getConnectivityTestSettings()
.setRetrySettings(
reachabilityServiceSettingsBuilder
.getConnectivityTestSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ReachabilityServiceSettings reachabilityServiceSettings =
reachabilityServiceSettingsBuilder.build();
ReachabilityServiceSettings.Builder
Builder for ReachabilityServiceSettings.
RerunConnectivityTestRequest
Request for the RerunConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.RerunConnectivityTestRequest
RerunConnectivityTestRequest.Builder
Request for the RerunConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.RerunConnectivityTestRequest
RouteInfo
For display only. Metadata associated with a Compute Engine route.
Protobuf type google.cloud.networkmanagement.v1beta1.RouteInfo
RouteInfo.Builder
For display only. Metadata associated with a Compute Engine route.
Protobuf type google.cloud.networkmanagement.v1beta1.RouteInfo
Step
A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.
Protobuf type google.cloud.networkmanagement.v1beta1.Step
Step.Builder
A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.
Protobuf type google.cloud.networkmanagement.v1beta1.Step
TestOuterClass
Trace
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.v1beta1.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.v1beta1.Trace
TraceProto
UpdateConnectivityTestRequest
Request for the UpdateConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.UpdateConnectivityTestRequest
UpdateConnectivityTestRequest.Builder
Request for the UpdateConnectivityTest
method.
Protobuf type google.cloud.networkmanagement.v1beta1.UpdateConnectivityTestRequest
VpnGatewayInfo
For display only. Metadata associated with a Compute Engine VPN gateway.
Protobuf type google.cloud.networkmanagement.v1beta1.VpnGatewayInfo
VpnGatewayInfo.Builder
For display only. Metadata associated with a Compute Engine VPN gateway.
Protobuf type google.cloud.networkmanagement.v1beta1.VpnGatewayInfo
VpnTunnelInfo
For display only. Metadata associated with a Compute Engine VPN tunnel.
Protobuf type google.cloud.networkmanagement.v1beta1.VpnTunnelInfo
VpnTunnelInfo.Builder
For display only. Metadata associated with a Compute Engine VPN tunnel.
Protobuf type google.cloud.networkmanagement.v1beta1.VpnTunnelInfo
Interfaces
AbortInfoOrBuilder
CloudSQLInstanceInfoOrBuilder
ConnectivityTestOrBuilder
CreateConnectivityTestRequestOrBuilder
DeleteConnectivityTestRequestOrBuilder
DeliverInfoOrBuilder
DropInfoOrBuilder
EndpointInfoOrBuilder
EndpointOrBuilder
FirewallInfoOrBuilder
ForwardInfoOrBuilder
ForwardingRuleInfoOrBuilder
GKEMasterInfoOrBuilder
GetConnectivityTestRequestOrBuilder
InstanceInfoOrBuilder
LatencyDistributionOrBuilder
LatencyPercentileOrBuilder
ListConnectivityTestsRequestOrBuilder
ListConnectivityTestsResponseOrBuilder
LoadBalancerBackendOrBuilder
LoadBalancerInfoOrBuilder
NetworkInfoOrBuilder
OperationMetadataOrBuilder
ProbingDetailsOrBuilder
ReachabilityDetailsOrBuilder
RerunConnectivityTestRequestOrBuilder
RouteInfoOrBuilder
StepOrBuilder
TraceOrBuilder
UpdateConnectivityTestRequestOrBuilder
VpnGatewayInfoOrBuilder
VpnTunnelInfoOrBuilder
Enums
AbortInfo.Cause
Abort cause types:
Protobuf enum google.cloud.networkmanagement.v1beta1.AbortInfo.Cause
DeliverInfo.Target
Deliver target types:
Protobuf enum google.cloud.networkmanagement.v1beta1.DeliverInfo.Target
DropInfo.Cause
Drop cause types:
Protobuf enum google.cloud.networkmanagement.v1beta1.DropInfo.Cause
Endpoint.NetworkType
The type definition of an endpoint's network. Use one of the following choices:
Protobuf enum google.cloud.networkmanagement.v1beta1.Endpoint.NetworkType
FirewallInfo.FirewallRuleType
The firewall rule's type.
Protobuf enum google.cloud.networkmanagement.v1beta1.FirewallInfo.FirewallRuleType
ForwardInfo.Target
Forward target types.
Protobuf enum google.cloud.networkmanagement.v1beta1.ForwardInfo.Target
LoadBalancerBackend.HealthCheckFirewallState
State of a health check firewall configuration:
Protobuf enum
google.cloud.networkmanagement.v1beta1.LoadBalancerBackend.HealthCheckFirewallState
LoadBalancerInfo.BackendType
The type definition for a load balancer backend configuration:
Protobuf enum google.cloud.networkmanagement.v1beta1.LoadBalancerInfo.BackendType
LoadBalancerInfo.LoadBalancerType
The type definition for a load balancer:
Protobuf enum google.cloud.networkmanagement.v1beta1.LoadBalancerInfo.LoadBalancerType
ProbingDetails.ProbingAbortCause
Abort cause types.
Protobuf enum google.cloud.networkmanagement.v1beta1.ProbingDetails.ProbingAbortCause
ProbingDetails.ProbingResult
Overall probing result of the test.
Protobuf enum google.cloud.networkmanagement.v1beta1.ProbingDetails.ProbingResult
ReachabilityDetails.Result
The overall result of the test's configuration analysis.
Protobuf enum google.cloud.networkmanagement.v1beta1.ReachabilityDetails.Result
RouteInfo.NextHopType
Type of next hop:
Protobuf enum google.cloud.networkmanagement.v1beta1.RouteInfo.NextHopType
RouteInfo.RouteType
Type of route:
Protobuf enum google.cloud.networkmanagement.v1beta1.RouteInfo.RouteType
Step.State
Type of states that are defined in the network state machine. Each step in the packet trace is in a specific state.
Protobuf enum google.cloud.networkmanagement.v1beta1.Step.State
Step.StepInfoCase
VpnTunnelInfo.RoutingType
Types of VPN routing policy. For details, refer to Networks and Tunnel routing.
Protobuf enum google.cloud.networkmanagement.v1beta1.VpnTunnelInfo.RoutingType