- 1.57.0 (latest)
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.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.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
GitHub Repository | Product Reference |
Service Description: The NodeTypes API.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String nodeType = "nodeType1123082332";
NodeType response = nodeTypesClient.get(project, zone, nodeType);
}
Note: close() needs to be called on the NodeTypesClient 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 |
---|---|---|
AggregatedList |
Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the |
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.
|
Get |
Returns the specified node type. |
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.
|
List |
Retrieves a list of node types available to the specified project. |
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.
|
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 NodeTypesSettings 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
NodeTypesSettings nodeTypesSettings =
NodeTypesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
NodeTypesClient nodeTypesClient = NodeTypesClient.create(nodeTypesSettings);
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
NodeTypesSettings nodeTypesSettings =
NodeTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
NodeTypesClient nodeTypesClient = NodeTypesClient.create(nodeTypesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final NodeTypesClient create()
Constructs an instance of NodeTypesClient with default settings.
Returns | |
---|---|
Type | Description |
NodeTypesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(NodeTypesSettings settings)
public static final NodeTypesClient create(NodeTypesSettings settings)
Constructs an instance of NodeTypesClient, 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 |
NodeTypesSettings |
Returns | |
---|---|
Type | Description |
NodeTypesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(NodeTypesStub stub)
public static final NodeTypesClient create(NodeTypesStub stub)
Constructs an instance of NodeTypesClient, using the given stub for making calls. This is for advanced usage - prefer using create(NodeTypesSettings).
Parameter | |
---|---|
Name | Description |
stub |
NodeTypesStub |
Returns | |
---|---|
Type | Description |
NodeTypesClient |
Constructors
NodeTypesClient(NodeTypesSettings settings)
protected NodeTypesClient(NodeTypesSettings settings)
Constructs an instance of NodeTypesClient, 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 |
NodeTypesSettings |
NodeTypesClient(NodeTypesStub stub)
protected NodeTypesClient(NodeTypesStub stub)
Parameter | |
---|---|
Name | Description |
stub |
NodeTypesStub |
Methods
aggregatedList(AggregatedListNodeTypesRequest request)
public final NodeTypesClient.AggregatedListPagedResponse aggregatedList(AggregatedListNodeTypesRequest request)
Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set
the returnPartialSuccess
parameter to true
.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
AggregatedListNodeTypesRequest request =
AggregatedListNodeTypesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setServiceProjectNumber(-1293855239)
.build();
for (Map.Entry<String, NodeTypesScopedList> element :
nodeTypesClient.aggregatedList(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
AggregatedListNodeTypesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
NodeTypesClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final NodeTypesClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set
the returnPartialSuccess
parameter to true
.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
String project = "project-309310695";
for (Map.Entry<String, NodeTypesScopedList> element :
nodeTypesClient.aggregatedList(project).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
project |
String Project ID for this request. |
Returns | |
---|---|
Type | Description |
NodeTypesClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListNodeTypesRequest,NodeTypeAggregatedList> aggregatedListCallable()
Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set
the returnPartialSuccess
parameter to true
.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
AggregatedListNodeTypesRequest request =
AggregatedListNodeTypesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setServiceProjectNumber(-1293855239)
.build();
while (true) {
NodeTypeAggregatedList response = nodeTypesClient.aggregatedListCallable().call(request);
for (Map.Entry<String, NodeTypesScopedList> element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AggregatedListNodeTypesRequest,NodeTypeAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListNodeTypesRequest,NodeTypesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set
the returnPartialSuccess
parameter to true
.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
AggregatedListNodeTypesRequest request =
AggregatedListNodeTypesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setServiceProjectNumber(-1293855239)
.build();
ApiFuture<Map.Entry<String, NodeTypesScopedList>> future =
nodeTypesClient.aggregatedListPagedCallable().futureCall(request);
// Do something.
for (Map.Entry<String, NodeTypesScopedList> element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AggregatedListNodeTypesRequest,AggregatedListPagedResponse> |
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()
get(GetNodeTypeRequest request)
public final NodeType get(GetNodeTypeRequest request)
Returns the specified node type.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
GetNodeTypeRequest request =
GetNodeTypeRequest.newBuilder()
.setNodeType("nodeType1123082332")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
NodeType response = nodeTypesClient.get(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetNodeTypeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
NodeType |
get(String project, String zone, String nodeType)
public final NodeType get(String project, String zone, String nodeType)
Returns the specified node type.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String nodeType = "nodeType1123082332";
NodeType response = nodeTypesClient.get(project, zone, nodeType);
}
Parameters | |
---|---|
Name | Description |
project |
String Project ID for this request. |
zone |
String The name of the zone for this request. |
nodeType |
String Name of the node type to return. |
Returns | |
---|---|
Type | Description |
NodeType |
getCallable()
public final UnaryCallable<GetNodeTypeRequest,NodeType> getCallable()
Returns the specified node type.
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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
GetNodeTypeRequest request =
GetNodeTypeRequest.newBuilder()
.setNodeType("nodeType1123082332")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
ApiFuture<NodeType> future = nodeTypesClient.getCallable().futureCall(request);
// Do something.
NodeType response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetNodeTypeRequest,NodeType> |
getSettings()
public final NodeTypesSettings getSettings()
Returns | |
---|---|
Type | Description |
NodeTypesSettings |
getStub()
public NodeTypesStub getStub()
Returns | |
---|---|
Type | Description |
NodeTypesStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
list(ListNodeTypesRequest request)
public final NodeTypesClient.ListPagedResponse list(ListNodeTypesRequest request)
Retrieves a list of node types available to 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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
ListNodeTypesRequest request =
ListNodeTypesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
for (NodeType element : nodeTypesClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListNodeTypesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
NodeTypesClient.ListPagedResponse |
list(String project, String zone)
public final NodeTypesClient.ListPagedResponse list(String project, String zone)
Retrieves a list of node types available to 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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
for (NodeType element : nodeTypesClient.list(project, zone).iterateAll()) {
// doThingsWith(element);
}
}
Parameters | |
---|---|
Name | Description |
project |
String Project ID for this request. |
zone |
String The name of the zone for this request. |
Returns | |
---|---|
Type | Description |
NodeTypesClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListNodeTypesRequest,NodeTypeList> listCallable()
Retrieves a list of node types available to 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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
ListNodeTypesRequest request =
ListNodeTypesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
while (true) {
NodeTypeList response = nodeTypesClient.listCallable().call(request);
for (NodeType element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListNodeTypesRequest,NodeTypeList> |
listPagedCallable()
public final UnaryCallable<ListNodeTypesRequest,NodeTypesClient.ListPagedResponse> listPagedCallable()
Retrieves a list of node types available to 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 (NodeTypesClient nodeTypesClient = NodeTypesClient.create()) {
ListNodeTypesRequest request =
ListNodeTypesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
ApiFuture<NodeType> future = nodeTypesClient.listPagedCallable().futureCall(request);
// Do something.
for (NodeType element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListNodeTypesRequest,ListPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()