Class VpcAccessServiceClient
- java.lang.Object
-
- com.google.cloud.vpcaccess.v1.VpcAccessServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource,AutoCloseable
@Generated("by gapic-generator-java") public class VpcAccessServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ConnectorName name = ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]"); Connector response = vpcAccessServiceClient.getConnector(name); }Note: close() needs to be called on the VpcAccessServiceClient 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 VpcAccessServiceSettings 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 VpcAccessServiceSettings vpcAccessServiceSettings = VpcAccessServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create(vpcAccessServiceSettings);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 VpcAccessServiceSettings vpcAccessServiceSettings = VpcAccessServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create(vpcAccessServiceSettings);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 VpcAccessServiceSettings vpcAccessServiceSettings = VpcAccessServiceSettings.newHttpJsonBuilder().build(); VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create(vpcAccessServiceSettings);Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVpcAccessServiceClient.ListConnectorsFixedSizeCollectionstatic classVpcAccessServiceClient.ListConnectorsPagestatic classVpcAccessServiceClient.ListConnectorsPagedResponsestatic classVpcAccessServiceClient.ListLocationsFixedSizeCollectionstatic classVpcAccessServiceClient.ListLocationsPagestatic classVpcAccessServiceClient.ListLocationsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protectedVpcAccessServiceClient(VpcAccessServiceStub stub)protectedVpcAccessServiceClient(VpcAccessServiceSettings settings)Constructs an instance of VpcAccessServiceClient, using the given settings.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanawaitTermination(long duration, TimeUnit unit)voidclose()static VpcAccessServiceClientcreate()Constructs an instance of VpcAccessServiceClient with default settings.static VpcAccessServiceClientcreate(VpcAccessServiceStub stub)Constructs an instance of VpcAccessServiceClient, using the given stub for making calls.static VpcAccessServiceClientcreate(VpcAccessServiceSettings settings)Constructs an instance of VpcAccessServiceClient, using the given settings.com.google.api.gax.longrunning.OperationFuture<Connector,OperationMetadata>createConnectorAsync(CreateConnectorRequest request)Creates a Serverless VPC Access connector, returns an operation.com.google.api.gax.longrunning.OperationFuture<Connector,OperationMetadata>createConnectorAsync(LocationName parent, String connectorId, Connector connector)Creates a Serverless VPC Access connector, returns an operation.com.google.api.gax.longrunning.OperationFuture<Connector,OperationMetadata>createConnectorAsync(String parent, String connectorId, Connector connector)Creates a Serverless VPC Access connector, returns an operation.com.google.api.gax.rpc.UnaryCallable<CreateConnectorRequest,com.google.longrunning.Operation>createConnectorCallable()Creates a Serverless VPC Access connector, returns an operation.com.google.api.gax.rpc.OperationCallable<CreateConnectorRequest,Connector,OperationMetadata>createConnectorOperationCallable()Creates a Serverless VPC Access connector, returns an operation.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>deleteConnectorAsync(ConnectorName name)Deletes a Serverless VPC Access connector.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>deleteConnectorAsync(DeleteConnectorRequest request)Deletes a Serverless VPC Access connector.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>deleteConnectorAsync(String name)Deletes a Serverless VPC Access connector.com.google.api.gax.rpc.UnaryCallable<DeleteConnectorRequest,com.google.longrunning.Operation>deleteConnectorCallable()Deletes a Serverless VPC Access connector.com.google.api.gax.rpc.OperationCallable<DeleteConnectorRequest,com.google.protobuf.Empty,OperationMetadata>deleteConnectorOperationCallable()Deletes a Serverless VPC Access connector.ConnectorgetConnector(ConnectorName name)Gets a Serverless VPC Access connector.ConnectorgetConnector(GetConnectorRequest request)Gets a Serverless VPC Access connector.ConnectorgetConnector(String name)Gets a Serverless VPC Access connector.com.google.api.gax.rpc.UnaryCallable<GetConnectorRequest,Connector>getConnectorCallable()Gets a Serverless VPC Access connector.com.google.api.gax.httpjson.longrunning.OperationsClientgetHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.longrunning.OperationsClientgetOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.VpcAccessServiceSettingsgetSettings()VpcAccessServiceStubgetStub()booleanisShutdown()booleanisTerminated()VpcAccessServiceClient.ListConnectorsPagedResponselistConnectors(ListConnectorsRequest request)Lists Serverless VPC Access connectors.VpcAccessServiceClient.ListConnectorsPagedResponselistConnectors(LocationName parent)Lists Serverless VPC Access connectors.VpcAccessServiceClient.ListConnectorsPagedResponselistConnectors(String parent)Lists Serverless VPC Access connectors.com.google.api.gax.rpc.UnaryCallable<ListConnectorsRequest,ListConnectorsResponse>listConnectorsCallable()Lists Serverless VPC Access connectors.com.google.api.gax.rpc.UnaryCallable<ListConnectorsRequest,VpcAccessServiceClient.ListConnectorsPagedResponse>listConnectorsPagedCallable()Lists Serverless VPC Access connectors.VpcAccessServiceClient.ListLocationsPagedResponselistLocations(com.google.cloud.location.ListLocationsRequest request)Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>listLocationsCallable()Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,VpcAccessServiceClient.ListLocationsPagedResponse>listLocationsPagedCallable()Lists information about the supported locations for this service.voidshutdown()voidshutdownNow()
-
-
-
Constructor Detail
-
VpcAccessServiceClient
protected VpcAccessServiceClient(VpcAccessServiceSettings settings) throws IOException
Constructs an instance of VpcAccessServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.- Throws:
IOException
-
VpcAccessServiceClient
protected VpcAccessServiceClient(VpcAccessServiceStub stub)
-
-
Method Detail
-
create
public static final VpcAccessServiceClient create() throws IOException
Constructs an instance of VpcAccessServiceClient with default settings.- Throws:
IOException
-
create
public static final VpcAccessServiceClient create(VpcAccessServiceSettings settings) throws IOException
Constructs an instance of VpcAccessServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final VpcAccessServiceClient create(VpcAccessServiceStub stub)
Constructs an instance of VpcAccessServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(VpcAccessServiceSettings).
-
getSettings
public final VpcAccessServiceSettings getSettings()
-
getStub
public VpcAccessServiceStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
createConnectorAsync
public final com.google.api.gax.longrunning.OperationFuture<Connector,OperationMetadata> createConnectorAsync(LocationName parent, String connectorId, Connector connector)
Creates a Serverless VPC Access connector, returns an operation.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String connectorId = "connectorId1724784200"; Connector connector = Connector.newBuilder().build(); Connector response = vpcAccessServiceClient.createConnectorAsync(parent, connectorId, connector).get(); }- Parameters:
parent- Required. The project and location in which the configuration should be created, specified in the format `projects/*/locations/*`.connectorId- Required. The ID to use for this connector.connector- Required. Resource to create.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
createConnectorAsync
public final com.google.api.gax.longrunning.OperationFuture<Connector,OperationMetadata> createConnectorAsync(String parent, String connectorId, Connector connector)
Creates a Serverless VPC Access connector, returns an operation.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String connectorId = "connectorId1724784200"; Connector connector = Connector.newBuilder().build(); Connector response = vpcAccessServiceClient.createConnectorAsync(parent, connectorId, connector).get(); }- Parameters:
parent- Required. The project and location in which the configuration should be created, specified in the format `projects/*/locations/*`.connectorId- Required. The ID to use for this connector.connector- Required. Resource to create.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
createConnectorAsync
public final com.google.api.gax.longrunning.OperationFuture<Connector,OperationMetadata> createConnectorAsync(CreateConnectorRequest request)
Creates a Serverless VPC Access connector, returns an operation.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { CreateConnectorRequest request = CreateConnectorRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setConnectorId("connectorId1724784200") .setConnector(Connector.newBuilder().build()) .build(); Connector response = vpcAccessServiceClient.createConnectorAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
createConnectorOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateConnectorRequest,Connector,OperationMetadata> createConnectorOperationCallable()
Creates a Serverless VPC Access connector, returns an operation.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { CreateConnectorRequest request = CreateConnectorRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setConnectorId("connectorId1724784200") .setConnector(Connector.newBuilder().build()) .build(); OperationFuture<Connector, OperationMetadata> future = vpcAccessServiceClient.createConnectorOperationCallable().futureCall(request); // Do something. Connector response = future.get(); }
-
createConnectorCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateConnectorRequest,com.google.longrunning.Operation> createConnectorCallable()
Creates a Serverless VPC Access connector, returns an operation.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { CreateConnectorRequest request = CreateConnectorRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setConnectorId("connectorId1724784200") .setConnector(Connector.newBuilder().build()) .build(); ApiFuture<Operation> future = vpcAccessServiceClient.createConnectorCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
getConnector
public final Connector getConnector(ConnectorName name)
Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ConnectorName name = ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]"); Connector response = vpcAccessServiceClient.getConnector(name); }- Parameters:
name- Required. Name of a Serverless VPC Access connector to get.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
getConnector
public final Connector getConnector(String name)
Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { String name = ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]").toString(); Connector response = vpcAccessServiceClient.getConnector(name); }- Parameters:
name- Required. Name of a Serverless VPC Access connector to get.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
getConnector
public final Connector getConnector(GetConnectorRequest request)
Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { GetConnectorRequest request = GetConnectorRequest.newBuilder() .setName(ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]").toString()) .build(); Connector response = vpcAccessServiceClient.getConnector(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
getConnectorCallable
public final com.google.api.gax.rpc.UnaryCallable<GetConnectorRequest,Connector> getConnectorCallable()
Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { GetConnectorRequest request = GetConnectorRequest.newBuilder() .setName(ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]").toString()) .build(); ApiFuture<Connector> future = vpcAccessServiceClient.getConnectorCallable().futureCall(request); // Do something. Connector response = future.get(); }
-
listConnectors
public final VpcAccessServiceClient.ListConnectorsPagedResponse listConnectors(LocationName parent)
Lists Serverless VPC Access connectors.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Connector element : vpcAccessServiceClient.listConnectors(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The project and location from which the routes should be listed.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
listConnectors
public final VpcAccessServiceClient.ListConnectorsPagedResponse listConnectors(String parent)
Lists Serverless VPC Access connectors.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Connector element : vpcAccessServiceClient.listConnectors(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The project and location from which the routes should be listed.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
listConnectors
public final VpcAccessServiceClient.ListConnectorsPagedResponse listConnectors(ListConnectorsRequest request)
Lists Serverless VPC Access connectors.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ListConnectorsRequest request = ListConnectorsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Connector element : vpcAccessServiceClient.listConnectors(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
listConnectorsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListConnectorsRequest,VpcAccessServiceClient.ListConnectorsPagedResponse> listConnectorsPagedCallable()
Lists Serverless VPC Access connectors.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ListConnectorsRequest request = ListConnectorsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Connector> future = vpcAccessServiceClient.listConnectorsPagedCallable().futureCall(request); // Do something. for (Connector element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listConnectorsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListConnectorsRequest,ListConnectorsResponse> listConnectorsCallable()
Lists Serverless VPC Access connectors.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ListConnectorsRequest request = ListConnectorsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListConnectorsResponse response = vpcAccessServiceClient.listConnectorsCallable().call(request); for (Connector element : response.getConnectorsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
deleteConnectorAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteConnectorAsync(ConnectorName name)
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ConnectorName name = ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]"); vpcAccessServiceClient.deleteConnectorAsync(name).get(); }- Parameters:
name- Required. Name of a Serverless VPC Access connector to delete.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
deleteConnectorAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteConnectorAsync(String name)
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { String name = ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]").toString(); vpcAccessServiceClient.deleteConnectorAsync(name).get(); }- Parameters:
name- Required. Name of a Serverless VPC Access connector to delete.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
deleteConnectorAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteConnectorAsync(DeleteConnectorRequest request)
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { DeleteConnectorRequest request = DeleteConnectorRequest.newBuilder() .setName(ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]").toString()) .build(); vpcAccessServiceClient.deleteConnectorAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
deleteConnectorOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteConnectorRequest,com.google.protobuf.Empty,OperationMetadata> deleteConnectorOperationCallable()
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { DeleteConnectorRequest request = DeleteConnectorRequest.newBuilder() .setName(ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]").toString()) .build(); OperationFuture<Empty, OperationMetadata> future = vpcAccessServiceClient.deleteConnectorOperationCallable().futureCall(request); // Do something. future.get(); }
-
deleteConnectorCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteConnectorRequest,com.google.longrunning.Operation> deleteConnectorCallable()
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { DeleteConnectorRequest request = DeleteConnectorRequest.newBuilder() .setName(ConnectorName.of("[PROJECT]", "[LOCATION]", "[CONNECTOR]").toString()) .build(); ApiFuture<Operation> future = vpcAccessServiceClient.deleteConnectorCallable().futureCall(request); // Do something. future.get(); }
-
listLocations
public final VpcAccessServiceClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : vpcAccessServiceClient.listLocations(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
listLocationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,VpcAccessServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = vpcAccessServiceClient.listLocationsPagedCallable().futureCall(request); // Do something. for (Location element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listLocationsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.Sample code:
// 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 (VpcAccessServiceClient vpcAccessServiceClient = VpcAccessServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = vpcAccessServiceClient.listLocationsCallable().call(request); for (Location element : response.getLocationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminatedin interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNowin interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException- Specified by:
awaitTerminationin interfacecom.google.api.gax.core.BackgroundResource- Throws:
InterruptedException
-
-