Class VpcAccessServiceClient (2.43.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.81.0 (latest)
- 2.79.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.71.0
- 2.69.0
- 2.68.0
- 2.65.0
- 2.64.0
- 2.63.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.1.10
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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ConnectorNamename=ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]");
Connectorresponse=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().
| Method | Description | Method Variants |
|---|---|---|
CreateConnector |
Creates a Serverless VPC Access connector, returns an operation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetConnector |
Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListConnectors |
Lists Serverless VPC Access connectors. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteConnector |
Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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
VpcAccessServiceSettingsvpcAccessServiceSettings=
VpcAccessServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
VpcAccessServiceClientvpcAccessServiceClient=
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
VpcAccessServiceSettingsvpcAccessServiceSettings=
VpcAccessServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
VpcAccessServiceClientvpcAccessServiceClient=
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
VpcAccessServiceSettingsvpcAccessServiceSettings=
VpcAccessServiceSettings.newHttpJsonBuilder().build();
VpcAccessServiceClientvpcAccessServiceClient=
VpcAccessServiceClient.create(vpcAccessServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
publicstaticfinalVpcAccessServiceClientcreate()Constructs an instance of VpcAccessServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(VpcAccessServiceSettings settings)
publicstaticfinalVpcAccessServiceClientcreate(VpcAccessServiceSettingssettings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
VpcAccessServiceSettings |
| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(VpcAccessServiceStub stub)
publicstaticfinalVpcAccessServiceClientcreate(VpcAccessServiceStubstub)Constructs an instance of VpcAccessServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(VpcAccessServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
VpcAccessServiceStub |
| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceClient |
|
Constructors
VpcAccessServiceClient(VpcAccessServiceSettings settings)
protectedVpcAccessServiceClient(VpcAccessServiceSettingssettings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
VpcAccessServiceSettings |
VpcAccessServiceClient(VpcAccessServiceStub stub)
protectedVpcAccessServiceClient(VpcAccessServiceStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
VpcAccessServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
publicfinalvoidclose()createConnectorAsync(CreateConnectorRequest request)
publicfinalOperationFuture<Connector,OperationMetadata>createConnectorAsync(CreateConnectorRequestrequest)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
CreateConnectorRequestrequest=
CreateConnectorRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setConnectorId("connectorId1724784200")
.setConnector(Connector.newBuilder().build())
.build();
Connectorresponse=vpcAccessServiceClient.createConnectorAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateConnectorRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Connector,OperationMetadata> |
|
createConnectorAsync(LocationName parent, String connectorId, Connector connector)
publicfinalOperationFuture<Connector,OperationMetadata>createConnectorAsync(LocationNameparent,StringconnectorId,Connectorconnector)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
StringconnectorId="connectorId1724784200";
Connectorconnector=Connector.newBuilder().build();
Connectorresponse=
vpcAccessServiceClient.createConnectorAsync(parent,connectorId,connector).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
LocationName Required. The project and location in which the configuration should be created,
specified in the format |
connectorId |
String Required. The ID to use for this connector. |
connector |
Connector Required. Resource to create. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Connector,OperationMetadata> |
|
createConnectorAsync(String parent, String connectorId, Connector connector)
publicfinalOperationFuture<Connector,OperationMetadata>createConnectorAsync(Stringparent,StringconnectorId,Connectorconnector)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
Stringparent=LocationName.of("[PROJECT]","[LOCATION]").toString();
StringconnectorId="connectorId1724784200";
Connectorconnector=Connector.newBuilder().build();
Connectorresponse=
vpcAccessServiceClient.createConnectorAsync(parent,connectorId,connector).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
String Required. The project and location in which the configuration should be created,
specified in the format |
connectorId |
String Required. The ID to use for this connector. |
connector |
Connector Required. Resource to create. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Connector,OperationMetadata> |
|
createConnectorCallable()
publicfinalUnaryCallable<CreateConnectorRequest,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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
CreateConnectorRequestrequest=
CreateConnectorRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setConnectorId("connectorId1724784200")
.setConnector(Connector.newBuilder().build())
.build();
ApiFuture<Operation>future=
vpcAccessServiceClient.createConnectorCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateConnectorRequest,Operation> |
|
createConnectorOperationCallable()
publicfinalOperationCallable<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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
CreateConnectorRequestrequest=
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.
Connectorresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateConnectorRequest,Connector,OperationMetadata> |
|
deleteConnectorAsync(ConnectorName name)
publicfinalOperationFuture<Empty,OperationMetadata>deleteConnectorAsync(ConnectorNamename)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ConnectorNamename=ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]");
vpcAccessServiceClient.deleteConnectorAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
ConnectorName Required. Name of a Serverless VPC Access connector to delete. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteConnectorAsync(DeleteConnectorRequest request)
publicfinalOperationFuture<Empty,OperationMetadata>deleteConnectorAsync(DeleteConnectorRequestrequest)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
DeleteConnectorRequestrequest=
DeleteConnectorRequest.newBuilder()
.setName(ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]").toString())
.build();
vpcAccessServiceClient.deleteConnectorAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteConnectorRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteConnectorAsync(String name)
publicfinalOperationFuture<Empty,OperationMetadata>deleteConnectorAsync(Stringname)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
Stringname=ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]").toString();
vpcAccessServiceClient.deleteConnectorAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
String Required. Name of a Serverless VPC Access connector to delete. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteConnectorCallable()
publicfinalUnaryCallable<DeleteConnectorRequest,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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
DeleteConnectorRequestrequest=
DeleteConnectorRequest.newBuilder()
.setName(ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]").toString())
.build();
ApiFuture<Operation>future=
vpcAccessServiceClient.deleteConnectorCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteConnectorRequest,Operation> |
|
deleteConnectorOperationCallable()
publicfinalOperationCallable<DeleteConnectorRequest,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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
DeleteConnectorRequestrequest=
DeleteConnectorRequest.newBuilder()
.setName(ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]").toString())
.build();
OperationFuture<Empty,OperationMetadata>future=
vpcAccessServiceClient.deleteConnectorOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteConnectorRequest,Empty,OperationMetadata> |
|
getConnector(ConnectorName name)
publicfinalConnectorgetConnector(ConnectorNamename)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ConnectorNamename=ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]");
Connectorresponse=vpcAccessServiceClient.getConnector(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
ConnectorName Required. Name of a Serverless VPC Access connector to get. |
| Returns | |
|---|---|
| Type | Description |
Connector |
|
getConnector(GetConnectorRequest request)
publicfinalConnectorgetConnector(GetConnectorRequestrequest)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
GetConnectorRequestrequest=
GetConnectorRequest.newBuilder()
.setName(ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]").toString())
.build();
Connectorresponse=vpcAccessServiceClient.getConnector(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetConnectorRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Connector |
|
getConnector(String name)
publicfinalConnectorgetConnector(Stringname)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
Stringname=ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]").toString();
Connectorresponse=vpcAccessServiceClient.getConnector(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
String Required. Name of a Serverless VPC Access connector to get. |
| Returns | |
|---|---|
| Type | Description |
Connector |
|
getConnectorCallable()
publicfinalUnaryCallable<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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
GetConnectorRequestrequest=
GetConnectorRequest.newBuilder()
.setName(ConnectorName.of("[PROJECT]","[LOCATION]","[CONNECTOR]").toString())
.build();
ApiFuture<Connector>future=
vpcAccessServiceClient.getConnectorCallable().futureCall(request);
// Do something.
Connectorresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetConnectorRequest,Connector> |
|
getHttpJsonOperationsClient()
publicfinalOperationsClientgetHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getOperationsClient()
publicfinalOperationsClientgetOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getSettings()
publicfinalVpcAccessServiceSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceSettings |
|
getStub()
publicVpcAccessServiceStubgetStub()| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listConnectors(ListConnectorsRequest request)
publicfinalVpcAccessServiceClient.ListConnectorsPagedResponselistConnectors(ListConnectorsRequestrequest)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ListConnectorsRequestrequest=
ListConnectorsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(Connectorelement:vpcAccessServiceClient.listConnectors(request).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListConnectorsRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceClient.ListConnectorsPagedResponse |
|
listConnectors(LocationName parent)
publicfinalVpcAccessServiceClient.ListConnectorsPagedResponselistConnectors(LocationNameparent)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
for(Connectorelement:vpcAccessServiceClient.listConnectors(parent).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
LocationName Required. The project and location from which the routes should be listed. |
| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceClient.ListConnectorsPagedResponse |
|
listConnectors(String parent)
publicfinalVpcAccessServiceClient.ListConnectorsPagedResponselistConnectors(Stringparent)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
Stringparent=LocationName.of("[PROJECT]","[LOCATION]").toString();
for(Connectorelement:vpcAccessServiceClient.listConnectors(parent).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
String Required. The project and location from which the routes should be listed. |
| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceClient.ListConnectorsPagedResponse |
|
listConnectorsCallable()
publicfinalUnaryCallable<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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ListConnectorsRequestrequest=
ListConnectorsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListConnectorsResponseresponse=
vpcAccessServiceClient.listConnectorsCallable().call(request);
for(Connectorelement:response.getConnectorsList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListConnectorsRequest,ListConnectorsResponse> |
|
listConnectorsPagedCallable()
publicfinalUnaryCallable<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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ListConnectorsRequestrequest=
ListConnectorsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Connector>future=
vpcAccessServiceClient.listConnectorsPagedCallable().futureCall(request);
// Do something.
for(Connectorelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListConnectorsRequest,ListConnectorsPagedResponse> |
|
listLocations(ListLocationsRequest request)
publicfinalVpcAccessServiceClient.ListLocationsPagedResponselistLocations(ListLocationsRequestrequest)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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(Locationelement:vpcAccessServiceClient.listLocations(request).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
VpcAccessServiceClient.ListLocationsPagedResponse |
|
listLocationsCallable()
publicfinalUnaryCallable<ListLocationsRequest,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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListLocationsResponseresponse=
vpcAccessServiceClient.listLocationsCallable().call(request);
for(Locationelement:response.getLocationsList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
|
listLocationsPagedCallable()
publicfinalUnaryCallable<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(VpcAccessServiceClientvpcAccessServiceClient=VpcAccessServiceClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location>future=
vpcAccessServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for(Locationelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
|
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()