- 1.46.0 (latest)
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.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.27.0
- 1.26.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.11.0
- 1.10.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.9
- 1.1.1
- 1.0.0
- 0.5.0
public class HubServiceClient implements BackgroundResource
Service Description: Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
HubName name = HubName.of("[PROJECT]", "[HUB]");
Hub response = hubServiceClient.getHub(name);
}
Note: close() needs to be called on the HubServiceClient 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 HubServiceSettings 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
HubServiceSettings hubServiceSettings =
HubServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
HubServiceClient hubServiceClient = HubServiceClient.create(hubServiceSettings);
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
HubServiceSettings hubServiceSettings =
HubServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
HubServiceClient hubServiceClient = HubServiceClient.create(hubServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final HubServiceClient create()
Constructs an instance of HubServiceClient with default settings.
Returns | |
---|---|
Type | Description |
HubServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(HubServiceSettings settings)
public static final HubServiceClient create(HubServiceSettings settings)
Constructs an instance of HubServiceClient, 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 | HubServiceSettings |
Returns | |
---|---|
Type | Description |
HubServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(HubServiceStub stub)
public static final HubServiceClient create(HubServiceStub stub)
Constructs an instance of HubServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(HubServiceSettings).
Parameter | |
---|---|
Name | Description |
stub | HubServiceStub |
Returns | |
---|---|
Type | Description |
HubServiceClient |
Constructors
HubServiceClient(HubServiceSettings settings)
protected HubServiceClient(HubServiceSettings settings)
Constructs an instance of HubServiceClient, 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 | HubServiceSettings |
HubServiceClient(HubServiceStub stub)
protected HubServiceClient(HubServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | HubServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createHubAsync(CreateHubRequest request)
public final OperationFuture<Hub,OperationMetadata> createHubAsync(CreateHubRequest request)
Creates a new Network Connectivity Center hub in the specified project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
CreateHubRequest request =
CreateHubRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setHubId("hubId99628272")
.setHub(Hub.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Hub response = hubServiceClient.createHubAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateHubRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Hub,OperationMetadata> |
createHubAsync(LocationName parent, Hub hub, String hubId)
public final OperationFuture<Hub,OperationMetadata> createHubAsync(LocationName parent, Hub hub, String hubId)
Creates a new Network Connectivity Center hub in the specified project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Hub hub = Hub.newBuilder().build();
String hubId = "hubId99628272";
Hub response = hubServiceClient.createHubAsync(parent, hub, hubId).get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource. |
hub | Hub Required. The initial values for a new hub. |
hubId | String Required. A unique identifier for the hub. |
Returns | |
---|---|
Type | Description |
OperationFuture<Hub,OperationMetadata> |
createHubAsync(String parent, Hub hub, String hubId)
public final OperationFuture<Hub,OperationMetadata> createHubAsync(String parent, Hub hub, String hubId)
Creates a new Network Connectivity Center hub in the specified project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Hub hub = Hub.newBuilder().build();
String hubId = "hubId99628272";
Hub response = hubServiceClient.createHubAsync(parent, hub, hubId).get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent resource. |
hub | Hub Required. The initial values for a new hub. |
hubId | String Required. A unique identifier for the hub. |
Returns | |
---|---|
Type | Description |
OperationFuture<Hub,OperationMetadata> |
createHubCallable()
public final UnaryCallable<CreateHubRequest,Operation> createHubCallable()
Creates a new Network Connectivity Center hub in the specified project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
CreateHubRequest request =
CreateHubRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setHubId("hubId99628272")
.setHub(Hub.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = hubServiceClient.createHubCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateHubRequest,Operation> |
createHubOperationCallable()
public final OperationCallable<CreateHubRequest,Hub,OperationMetadata> createHubOperationCallable()
Creates a new Network Connectivity Center hub in the specified project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
CreateHubRequest request =
CreateHubRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setHubId("hubId99628272")
.setHub(Hub.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Hub, OperationMetadata> future =
hubServiceClient.createHubOperationCallable().futureCall(request);
// Do something.
Hub response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateHubRequest,Hub,OperationMetadata> |
createSpokeAsync(CreateSpokeRequest request)
public final OperationFuture<Spoke,OperationMetadata> createSpokeAsync(CreateSpokeRequest request)
Creates a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
CreateSpokeRequest request =
CreateSpokeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSpokeId("spokeId-1998996281")
.setSpoke(Spoke.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Spoke response = hubServiceClient.createSpokeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateSpokeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Spoke,OperationMetadata> |
createSpokeAsync(LocationName parent, Spoke spoke, String spokeId)
public final OperationFuture<Spoke,OperationMetadata> createSpokeAsync(LocationName parent, Spoke spoke, String spokeId)
Creates a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Spoke spoke = Spoke.newBuilder().build();
String spokeId = "spokeId-1998996281";
Spoke response = hubServiceClient.createSpokeAsync(parent, spoke, spokeId).get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource. |
spoke | Spoke Required. The initial values for a new spoke. |
spokeId | String Required. Unique id for the spoke to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<Spoke,OperationMetadata> |
createSpokeAsync(String parent, Spoke spoke, String spokeId)
public final OperationFuture<Spoke,OperationMetadata> createSpokeAsync(String parent, Spoke spoke, String spokeId)
Creates a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Spoke spoke = Spoke.newBuilder().build();
String spokeId = "spokeId-1998996281";
Spoke response = hubServiceClient.createSpokeAsync(parent, spoke, spokeId).get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent resource. |
spoke | Spoke Required. The initial values for a new spoke. |
spokeId | String Required. Unique id for the spoke to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<Spoke,OperationMetadata> |
createSpokeCallable()
public final UnaryCallable<CreateSpokeRequest,Operation> createSpokeCallable()
Creates a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
CreateSpokeRequest request =
CreateSpokeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSpokeId("spokeId-1998996281")
.setSpoke(Spoke.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = hubServiceClient.createSpokeCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateSpokeRequest,Operation> |
createSpokeOperationCallable()
public final OperationCallable<CreateSpokeRequest,Spoke,OperationMetadata> createSpokeOperationCallable()
Creates a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
CreateSpokeRequest request =
CreateSpokeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSpokeId("spokeId-1998996281")
.setSpoke(Spoke.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Spoke, OperationMetadata> future =
hubServiceClient.createSpokeOperationCallable().futureCall(request);
// Do something.
Spoke response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateSpokeRequest,Spoke,OperationMetadata> |
deleteHubAsync(DeleteHubRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteHubAsync(DeleteHubRequest request)
Deletes a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
DeleteHubRequest request =
DeleteHubRequest.newBuilder()
.setName(HubName.of("[PROJECT]", "[HUB]").toString())
.setRequestId("requestId693933066")
.build();
hubServiceClient.deleteHubAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteHubRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteHubAsync(HubName name)
public final OperationFuture<Empty,OperationMetadata> deleteHubAsync(HubName name)
Deletes a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
HubName name = HubName.of("[PROJECT]", "[HUB]");
hubServiceClient.deleteHubAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | HubName Required. The name of the hub to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteHubAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteHubAsync(String name)
Deletes a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String name = HubName.of("[PROJECT]", "[HUB]").toString();
hubServiceClient.deleteHubAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the hub to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteHubCallable()
public final UnaryCallable<DeleteHubRequest,Operation> deleteHubCallable()
Deletes a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
DeleteHubRequest request =
DeleteHubRequest.newBuilder()
.setName(HubName.of("[PROJECT]", "[HUB]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = hubServiceClient.deleteHubCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteHubRequest,Operation> |
deleteHubOperationCallable()
public final OperationCallable<DeleteHubRequest,Empty,OperationMetadata> deleteHubOperationCallable()
Deletes a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
DeleteHubRequest request =
DeleteHubRequest.newBuilder()
.setName(HubName.of("[PROJECT]", "[HUB]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
hubServiceClient.deleteHubOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteHubRequest,Empty,OperationMetadata> |
deleteSpokeAsync(DeleteSpokeRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteSpokeAsync(DeleteSpokeRequest request)
Deletes a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
DeleteSpokeRequest request =
DeleteSpokeRequest.newBuilder()
.setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
.setRequestId("requestId693933066")
.build();
hubServiceClient.deleteSpokeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteSpokeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteSpokeAsync(SpokeName name)
public final OperationFuture<Empty,OperationMetadata> deleteSpokeAsync(SpokeName name)
Deletes a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
SpokeName name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]");
hubServiceClient.deleteSpokeAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | SpokeName Required. The name of the spoke to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteSpokeAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteSpokeAsync(String name)
Deletes a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString();
hubServiceClient.deleteSpokeAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the spoke to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteSpokeCallable()
public final UnaryCallable<DeleteSpokeRequest,Operation> deleteSpokeCallable()
Deletes a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
DeleteSpokeRequest request =
DeleteSpokeRequest.newBuilder()
.setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = hubServiceClient.deleteSpokeCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteSpokeRequest,Operation> |
deleteSpokeOperationCallable()
public final OperationCallable<DeleteSpokeRequest,Empty,OperationMetadata> deleteSpokeOperationCallable()
Deletes a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
DeleteSpokeRequest request =
DeleteSpokeRequest.newBuilder()
.setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
hubServiceClient.deleteSpokeOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteSpokeRequest,Empty,OperationMetadata> |
getHub(GetHubRequest request)
public final Hub getHub(GetHubRequest request)
Gets details about a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
GetHubRequest request =
GetHubRequest.newBuilder().setName(HubName.of("[PROJECT]", "[HUB]").toString()).build();
Hub response = hubServiceClient.getHub(request);
}
Parameter | |
---|---|
Name | Description |
request | GetHubRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Hub |
getHub(HubName name)
public final Hub getHub(HubName name)
Gets details about a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
HubName name = HubName.of("[PROJECT]", "[HUB]");
Hub response = hubServiceClient.getHub(name);
}
Parameter | |
---|---|
Name | Description |
name | HubName Required. The name of the hub resource to get. |
Returns | |
---|---|
Type | Description |
Hub |
getHub(String name)
public final Hub getHub(String name)
Gets details about a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String name = HubName.of("[PROJECT]", "[HUB]").toString();
Hub response = hubServiceClient.getHub(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the hub resource to get. |
Returns | |
---|---|
Type | Description |
Hub |
getHubCallable()
public final UnaryCallable<GetHubRequest,Hub> getHubCallable()
Gets details about a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
GetHubRequest request =
GetHubRequest.newBuilder().setName(HubName.of("[PROJECT]", "[HUB]").toString()).build();
ApiFuture<Hub> future = hubServiceClient.getHubCallable().futureCall(request);
// Do something.
Hub response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetHubRequest,Hub> |
getOperationsClient()
public final OperationsClient getOperationsClient()
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()
public final HubServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
HubServiceSettings |
getSpoke(GetSpokeRequest request)
public final Spoke getSpoke(GetSpokeRequest request)
Gets details about a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
GetSpokeRequest request =
GetSpokeRequest.newBuilder()
.setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
.build();
Spoke response = hubServiceClient.getSpoke(request);
}
Parameter | |
---|---|
Name | Description |
request | GetSpokeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Spoke |
getSpoke(SpokeName name)
public final Spoke getSpoke(SpokeName name)
Gets details about a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
SpokeName name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]");
Spoke response = hubServiceClient.getSpoke(name);
}
Parameter | |
---|---|
Name | Description |
name | SpokeName Required. The name of the spoke resource. |
Returns | |
---|---|
Type | Description |
Spoke |
getSpoke(String name)
public final Spoke getSpoke(String name)
Gets details about a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String name = SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString();
Spoke response = hubServiceClient.getSpoke(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the spoke resource. |
Returns | |
---|---|
Type | Description |
Spoke |
getSpokeCallable()
public final UnaryCallable<GetSpokeRequest,Spoke> getSpokeCallable()
Gets details about a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
GetSpokeRequest request =
GetSpokeRequest.newBuilder()
.setName(SpokeName.of("[PROJECT]", "[LOCATION]", "[SPOKE]").toString())
.build();
ApiFuture<Spoke> future = hubServiceClient.getSpokeCallable().futureCall(request);
// Do something.
Spoke response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetSpokeRequest,Spoke> |
getStub()
public HubServiceStub getStub()
Returns | |
---|---|
Type | Description |
HubServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listHubs(ListHubsRequest request)
public final HubServiceClient.ListHubsPagedResponse listHubs(ListHubsRequest request)
Lists the Network Connectivity Center hubs associated with a given project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
ListHubsRequest request =
ListHubsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Hub element : hubServiceClient.listHubs(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListHubsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
HubServiceClient.ListHubsPagedResponse |
listHubs(LocationName parent)
public final HubServiceClient.ListHubsPagedResponse listHubs(LocationName parent)
Lists the Network Connectivity Center hubs associated with a given project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Hub element : hubServiceClient.listHubs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource's name. |
Returns | |
---|---|
Type | Description |
HubServiceClient.ListHubsPagedResponse |
listHubs(String parent)
public final HubServiceClient.ListHubsPagedResponse listHubs(String parent)
Lists the Network Connectivity Center hubs associated with a given project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Hub element : hubServiceClient.listHubs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent resource's name. |
Returns | |
---|---|
Type | Description |
HubServiceClient.ListHubsPagedResponse |
listHubsCallable()
public final UnaryCallable<ListHubsRequest,ListHubsResponse> listHubsCallable()
Lists the Network Connectivity Center hubs associated with a given project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
ListHubsRequest request =
ListHubsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListHubsResponse response = hubServiceClient.listHubsCallable().call(request);
for (Hub element : response.getHubsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListHubsRequest,ListHubsResponse> |
listHubsPagedCallable()
public final UnaryCallable<ListHubsRequest,HubServiceClient.ListHubsPagedResponse> listHubsPagedCallable()
Lists the Network Connectivity Center hubs associated with a given project.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
ListHubsRequest request =
ListHubsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Hub> future = hubServiceClient.listHubsPagedCallable().futureCall(request);
// Do something.
for (Hub element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListHubsRequest,ListHubsPagedResponse> |
listSpokes(ListSpokesRequest request)
public final HubServiceClient.ListSpokesPagedResponse listSpokes(ListSpokesRequest request)
Lists the Network Connectivity Center spokes in a specified project and location.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
ListSpokesRequest request =
ListSpokesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Spoke element : hubServiceClient.listSpokes(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListSpokesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
HubServiceClient.ListSpokesPagedResponse |
listSpokes(LocationName parent)
public final HubServiceClient.ListSpokesPagedResponse listSpokes(LocationName parent)
Lists the Network Connectivity Center spokes in a specified project and location.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Spoke element : hubServiceClient.listSpokes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource. |
Returns | |
---|---|
Type | Description |
HubServiceClient.ListSpokesPagedResponse |
listSpokes(String parent)
public final HubServiceClient.ListSpokesPagedResponse listSpokes(String parent)
Lists the Network Connectivity Center spokes in a specified project and location.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Spoke element : hubServiceClient.listSpokes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent resource. |
Returns | |
---|---|
Type | Description |
HubServiceClient.ListSpokesPagedResponse |
listSpokesCallable()
public final UnaryCallable<ListSpokesRequest,ListSpokesResponse> listSpokesCallable()
Lists the Network Connectivity Center spokes in a specified project and location.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
ListSpokesRequest request =
ListSpokesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListSpokesResponse response = hubServiceClient.listSpokesCallable().call(request);
for (Spoke element : response.getSpokesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListSpokesRequest,ListSpokesResponse> |
listSpokesPagedCallable()
public final UnaryCallable<ListSpokesRequest,HubServiceClient.ListSpokesPagedResponse> listSpokesPagedCallable()
Lists the Network Connectivity Center spokes in a specified project and location.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
ListSpokesRequest request =
ListSpokesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Spoke> future = hubServiceClient.listSpokesPagedCallable().futureCall(request);
// Do something.
for (Spoke element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListSpokesRequest,ListSpokesPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateHubAsync(Hub hub, FieldMask updateMask)
public final OperationFuture<Hub,OperationMetadata> updateHubAsync(Hub hub, FieldMask updateMask)
Updates the description and/or labels of a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
Hub hub = Hub.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Hub response = hubServiceClient.updateHubAsync(hub, updateMask).get();
}
Parameters | |
---|---|
Name | Description |
hub | Hub Required. The state that the hub should be in after the update. |
updateMask | FieldMask Optional. In the case of an update to an existing hub, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. |
Returns | |
---|---|
Type | Description |
OperationFuture<Hub,OperationMetadata> |
updateHubAsync(UpdateHubRequest request)
public final OperationFuture<Hub,OperationMetadata> updateHubAsync(UpdateHubRequest request)
Updates the description and/or labels of a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
UpdateHubRequest request =
UpdateHubRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setHub(Hub.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Hub response = hubServiceClient.updateHubAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | UpdateHubRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Hub,OperationMetadata> |
updateHubCallable()
public final UnaryCallable<UpdateHubRequest,Operation> updateHubCallable()
Updates the description and/or labels of a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
UpdateHubRequest request =
UpdateHubRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setHub(Hub.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = hubServiceClient.updateHubCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateHubRequest,Operation> |
updateHubOperationCallable()
public final OperationCallable<UpdateHubRequest,Hub,OperationMetadata> updateHubOperationCallable()
Updates the description and/or labels of a Network Connectivity Center hub.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
UpdateHubRequest request =
UpdateHubRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setHub(Hub.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Hub, OperationMetadata> future =
hubServiceClient.updateHubOperationCallable().futureCall(request);
// Do something.
Hub response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateHubRequest,Hub,OperationMetadata> |
updateSpokeAsync(Spoke spoke, FieldMask updateMask)
public final OperationFuture<Spoke,OperationMetadata> updateSpokeAsync(Spoke spoke, FieldMask updateMask)
Updates the parameters of a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
Spoke spoke = Spoke.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Spoke response = hubServiceClient.updateSpokeAsync(spoke, updateMask).get();
}
Parameters | |
---|---|
Name | Description |
spoke | Spoke Required. The state that the spoke should be in after the update. |
updateMask | FieldMask Optional. In the case of an update to an existing spoke, field mask is used to specify the fields to be overwritten. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten. |
Returns | |
---|---|
Type | Description |
OperationFuture<Spoke,OperationMetadata> |
updateSpokeAsync(UpdateSpokeRequest request)
public final OperationFuture<Spoke,OperationMetadata> updateSpokeAsync(UpdateSpokeRequest request)
Updates the parameters of a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
UpdateSpokeRequest request =
UpdateSpokeRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setSpoke(Spoke.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Spoke response = hubServiceClient.updateSpokeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | UpdateSpokeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Spoke,OperationMetadata> |
updateSpokeCallable()
public final UnaryCallable<UpdateSpokeRequest,Operation> updateSpokeCallable()
Updates the parameters of a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
UpdateSpokeRequest request =
UpdateSpokeRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setSpoke(Spoke.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = hubServiceClient.updateSpokeCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateSpokeRequest,Operation> |
updateSpokeOperationCallable()
public final OperationCallable<UpdateSpokeRequest,Spoke,OperationMetadata> updateSpokeOperationCallable()
Updates the parameters of a Network Connectivity Center spoke.
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 (HubServiceClient hubServiceClient = HubServiceClient.create()) {
UpdateSpokeRequest request =
UpdateSpokeRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setSpoke(Spoke.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Spoke, OperationMetadata> future =
hubServiceClient.updateSpokeOperationCallable().futureCall(request);
// Do something.
Spoke response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateSpokeRequest,Spoke,OperationMetadata> |