Package com.google.cloud.compute.v1

Class NodeTypesClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class NodeTypesClient
extends Object
implements com.google.api.gax.core.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.

    • Constructor Detail

      • NodeTypesClient

        protected NodeTypesClient​(NodeTypesSettings settings)
                   throws IOException
        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.
        Throws:
        IOException

      • NodeTypesClient

        protected NodeTypesClient​(NodeTypesStub stub)

    • Method Detail

      • create

        public static final NodeTypesClient create​(NodeTypesSettings settings)
                                    throws IOException
        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.
        Throws:
        IOException

      • create

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

      • aggregatedList

        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);
   }
 }
        Parameters:
        project - Project ID for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • aggregatedList

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • aggregatedListPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • aggregatedListCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • get

        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:
        project - Project ID for this request.
        zone - The name of the zone for this request.
        nodeType - Name of the node type to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • get

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getCallable

        public final com.google.api.gax.rpc.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();
 }

      • list

        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:
        project - Project ID for this request.
        zone - The name of the zone for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • list

        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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource