Class NodeTypesClient (1.39.0)

public class NodeTypesClient implements BackgroundResource

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().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. 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.
  2. 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.
  3. 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 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.

Inheritance

java.lang.Object > NodeTypesClient

Implements

BackgroundResource

Static Methods

create()

public static final NodeTypesClient create()

Constructs an instance of NodeTypesClient with default settings.

Returns
TypeDescription
NodeTypesClient
Exceptions
TypeDescription
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
NameDescription
settingsNodeTypesSettings
Returns
TypeDescription
NodeTypesClient
Exceptions
TypeDescription
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
NameDescription
stubNodeTypesStub
Returns
TypeDescription
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
NameDescription
settingsNodeTypesSettings

NodeTypesClient(NodeTypesStub stub)

protected NodeTypesClient(NodeTypesStub stub)
Parameter
NameDescription
stubNodeTypesStub

Methods

aggregatedList(AggregatedListNodeTypesRequest request)

public final NodeTypesClient.AggregatedListPagedResponse aggregatedList(AggregatedListNodeTypesRequest request)

Retrieves an aggregated list of node types.

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)
           .build();
   for (Map.Entry<String, NodeTypesScopedList> element :
       nodeTypesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestAggregatedListNodeTypesRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
NodeTypesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final NodeTypesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of node types.

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
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
NodeTypesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListNodeTypesRequest,NodeTypeAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of node types.

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)
           .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
TypeDescription
UnaryCallable<AggregatedListNodeTypesRequest,NodeTypeAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListNodeTypesRequest,NodeTypesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of node types.

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)
           .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
TypeDescription
UnaryCallable<AggregatedListNodeTypesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
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
NameDescription
requestGetNodeTypeRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

nodeTypeString

Name of the node type to return.

Returns
TypeDescription
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
TypeDescription
UnaryCallable<GetNodeTypeRequest,NodeType>

getSettings()

public final NodeTypesSettings getSettings()
Returns
TypeDescription
NodeTypesSettings

getStub()

public NodeTypesStub getStub()
Returns
TypeDescription
NodeTypesStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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
NameDescription
requestListNodeTypesRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListNodeTypesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()