Package com.google.cloud.networkconnectivity.v1

Class InternalRangeServiceClient

java.lang.Object
com.google.cloud.networkconnectivity.v1.InternalRangeServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class InternalRangeServiceClient extends Object implements BackgroundResource
Service Description: The CLH-based service for internal range resources used to perform IPAM operations within a VPC network.

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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   InternalRangeName name = InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]");
   InternalRange response = internalRangeServiceClient.getInternalRange(name);
 }

Note: close() needs to be called on the InternalRangeServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListInternalRanges

Lists internal ranges in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInternalRanges(ListInternalRangesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInternalRanges(LocationName parent)

  • listInternalRanges(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInternalRangesPagedCallable()

  • listInternalRangesCallable()

GetInternalRange

Gets details of a single internal range.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getInternalRange(GetInternalRangeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getInternalRange(InternalRangeName name)

  • getInternalRange(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getInternalRangeCallable()

CreateInternalRange

Creates a new internal range in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createInternalRangeAsync(CreateInternalRangeRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • createInternalRangeAsync(LocationName parent, InternalRange internalRange, String internalRangeId)

  • createInternalRangeAsync(String parent, InternalRange internalRange, String internalRangeId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createInternalRangeOperationCallable()

  • createInternalRangeCallable()

UpdateInternalRange

Updates the parameters of a single internal range.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateInternalRangeAsync(UpdateInternalRangeRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • updateInternalRangeAsync(InternalRange internalRange, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateInternalRangeOperationCallable()

  • updateInternalRangeCallable()

DeleteInternalRange

Deletes a single internal range.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteInternalRangeAsync(DeleteInternalRangeRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • deleteInternalRangeAsync(InternalRangeName name)

  • deleteInternalRangeAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteInternalRangeOperationCallable()

  • deleteInternalRangeCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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 InternalRangeServiceSettings 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
 InternalRangeServiceSettings internalRangeServiceSettings =
     InternalRangeServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create(internalRangeServiceSettings);

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
 InternalRangeServiceSettings internalRangeServiceSettings =
     InternalRangeServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create(internalRangeServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

  • Constructor Details

    • InternalRangeServiceClient

      protected InternalRangeServiceClient(InternalRangeServiceSettings settings) throws IOException
      Constructs an instance of InternalRangeServiceClient, 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

    • InternalRangeServiceClient

      protected InternalRangeServiceClient(InternalRangeServiceStub stub)

  • Method Details

    • create

      public static final InternalRangeServiceClient create() throws IOException
      Constructs an instance of InternalRangeServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final InternalRangeServiceClient create(InternalRangeServiceSettings settings) throws IOException
      Constructs an instance of InternalRangeServiceClient, 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 InternalRangeServiceClient create(InternalRangeServiceStub stub)
      Constructs an instance of InternalRangeServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(InternalRangeServiceSettings).

    • getSettings

      public final InternalRangeServiceSettings getSettings()

    • getStub

      public InternalRangeServiceStub getStub()

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

    • listInternalRanges

      public final InternalRangeServiceClient.ListInternalRangesPagedResponse listInternalRanges(LocationName parent)
      Lists internal ranges in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (InternalRange element :
       internalRangeServiceClient.listInternalRanges(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent resource's name.
      Throws:
      ApiException - if the remote call fails

    • listInternalRanges

      public final InternalRangeServiceClient.ListInternalRangesPagedResponse listInternalRanges(String parent)
      Lists internal ranges in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (InternalRange element :
       internalRangeServiceClient.listInternalRanges(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent resource's name.
      Throws:
      ApiException - if the remote call fails

    • listInternalRanges

      public final InternalRangeServiceClient.ListInternalRangesPagedResponse listInternalRanges(ListInternalRangesRequest request)
      Lists internal ranges in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   ListInternalRangesRequest request =
       ListInternalRangesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (InternalRange element :
       internalRangeServiceClient.listInternalRanges(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listInternalRangesPagedCallable

      public final UnaryCallable<ListInternalRangesRequest,InternalRangeServiceClient.ListInternalRangesPagedResponse> listInternalRangesPagedCallable()
      Lists internal ranges in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   ListInternalRangesRequest request =
       ListInternalRangesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<InternalRange> future =
       internalRangeServiceClient.listInternalRangesPagedCallable().futureCall(request);
   // Do something.
   for (InternalRange element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listInternalRangesCallable

      public final UnaryCallable<ListInternalRangesRequest,ListInternalRangesResponse> listInternalRangesCallable()
      Lists internal ranges in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   ListInternalRangesRequest request =
       ListInternalRangesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListInternalRangesResponse response =
         internalRangeServiceClient.listInternalRangesCallable().call(request);
     for (InternalRange element : response.getInternalRangesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getInternalRange

      public final InternalRange getInternalRange(InternalRangeName name)
      Gets details of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   InternalRangeName name = InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]");
   InternalRange response = internalRangeServiceClient.getInternalRange(name);
 }
      Parameters:
      name - Required. Name of the InternalRange to get.
      Throws:
      ApiException - if the remote call fails

    • getInternalRange

      public final InternalRange getInternalRange(String name)
      Gets details of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   String name = InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]").toString();
   InternalRange response = internalRangeServiceClient.getInternalRange(name);
 }
      Parameters:
      name - Required. Name of the InternalRange to get.
      Throws:
      ApiException - if the remote call fails

    • getInternalRange

      public final InternalRange getInternalRange(GetInternalRangeRequest request)
      Gets details of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   GetInternalRangeRequest request =
       GetInternalRangeRequest.newBuilder()
           .setName(
               InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]").toString())
           .build();
   InternalRange response = internalRangeServiceClient.getInternalRange(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getInternalRangeCallable

      public final UnaryCallable<GetInternalRangeRequest,InternalRange> getInternalRangeCallable()
      Gets details of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   GetInternalRangeRequest request =
       GetInternalRangeRequest.newBuilder()
           .setName(
               InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]").toString())
           .build();
   ApiFuture<InternalRange> future =
       internalRangeServiceClient.getInternalRangeCallable().futureCall(request);
   // Do something.
   InternalRange response = future.get();
 }

    • createInternalRangeAsync

      public final OperationFuture<InternalRange,OperationMetadata> createInternalRangeAsync(LocationName parent, InternalRange internalRange, String internalRangeId)
      Creates a new internal range in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   InternalRange internalRange = InternalRange.newBuilder().build();
   String internalRangeId = "internalRangeId-392750661";
   InternalRange response =
       internalRangeServiceClient
           .createInternalRangeAsync(parent, internalRange, internalRangeId)
           .get();
 }
      Parameters:
      parent - Required. The parent resource's name of the internal range.
      internalRange - Required. Initial values for a new internal range
      internalRangeId - Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
      Throws:
      ApiException - if the remote call fails

    • createInternalRangeAsync

      public final OperationFuture<InternalRange,OperationMetadata> createInternalRangeAsync(String parent, InternalRange internalRange, String internalRangeId)
      Creates a new internal range in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   InternalRange internalRange = InternalRange.newBuilder().build();
   String internalRangeId = "internalRangeId-392750661";
   InternalRange response =
       internalRangeServiceClient
           .createInternalRangeAsync(parent, internalRange, internalRangeId)
           .get();
 }
      Parameters:
      parent - Required. The parent resource's name of the internal range.
      internalRange - Required. Initial values for a new internal range
      internalRangeId - Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.
      Throws:
      ApiException - if the remote call fails

    • createInternalRangeAsync

      public final OperationFuture<InternalRange,OperationMetadata> createInternalRangeAsync(CreateInternalRangeRequest request)
      Creates a new internal range in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   CreateInternalRangeRequest request =
       CreateInternalRangeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInternalRangeId("internalRangeId-392750661")
           .setInternalRange(InternalRange.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   InternalRange response = internalRangeServiceClient.createInternalRangeAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createInternalRangeOperationCallable

      public final OperationCallable<CreateInternalRangeRequest,InternalRange,OperationMetadata> createInternalRangeOperationCallable()
      Creates a new internal range in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   CreateInternalRangeRequest request =
       CreateInternalRangeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInternalRangeId("internalRangeId-392750661")
           .setInternalRange(InternalRange.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<InternalRange, OperationMetadata> future =
       internalRangeServiceClient.createInternalRangeOperationCallable().futureCall(request);
   // Do something.
   InternalRange response = future.get();
 }

    • createInternalRangeCallable

      public final UnaryCallable<CreateInternalRangeRequest,Operation> createInternalRangeCallable()
      Creates a new internal range in a given 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   CreateInternalRangeRequest request =
       CreateInternalRangeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInternalRangeId("internalRangeId-392750661")
           .setInternalRange(InternalRange.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       internalRangeServiceClient.createInternalRangeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • updateInternalRangeAsync

      public final OperationFuture<InternalRange,OperationMetadata> updateInternalRangeAsync(InternalRange internalRange, com.google.protobuf.FieldMask updateMask)
      Updates the parameters of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   InternalRange internalRange = InternalRange.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   InternalRange response =
       internalRangeServiceClient.updateInternalRangeAsync(internalRange, updateMask).get();
 }
      Parameters:
      internalRange - Required. New values to be patched into the resource.
      updateMask - Optional. Field mask is used to specify the fields to be overwritten in the InternalRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
      Throws:
      ApiException - if the remote call fails

    • updateInternalRangeAsync

      public final OperationFuture<InternalRange,OperationMetadata> updateInternalRangeAsync(UpdateInternalRangeRequest request)
      Updates the parameters of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   UpdateInternalRangeRequest request =
       UpdateInternalRangeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInternalRange(InternalRange.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   InternalRange response = internalRangeServiceClient.updateInternalRangeAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateInternalRangeOperationCallable

      public final OperationCallable<UpdateInternalRangeRequest,InternalRange,OperationMetadata> updateInternalRangeOperationCallable()
      Updates the parameters of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   UpdateInternalRangeRequest request =
       UpdateInternalRangeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInternalRange(InternalRange.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<InternalRange, OperationMetadata> future =
       internalRangeServiceClient.updateInternalRangeOperationCallable().futureCall(request);
   // Do something.
   InternalRange response = future.get();
 }

    • updateInternalRangeCallable

      public final UnaryCallable<UpdateInternalRangeRequest,Operation> updateInternalRangeCallable()
      Updates the parameters of a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   UpdateInternalRangeRequest request =
       UpdateInternalRangeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setInternalRange(InternalRange.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       internalRangeServiceClient.updateInternalRangeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • deleteInternalRangeAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInternalRangeAsync(InternalRangeName name)
      Deletes a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   InternalRangeName name = InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]");
   internalRangeServiceClient.deleteInternalRangeAsync(name).get();
 }
      Parameters:
      name - Required. The name of the internal range to delete.
      Throws:
      ApiException - if the remote call fails

    • deleteInternalRangeAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInternalRangeAsync(String name)
      Deletes a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   String name = InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]").toString();
   internalRangeServiceClient.deleteInternalRangeAsync(name).get();
 }
      Parameters:
      name - Required. The name of the internal range to delete.
      Throws:
      ApiException - if the remote call fails

    • deleteInternalRangeAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInternalRangeAsync(DeleteInternalRangeRequest request)
      Deletes a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   DeleteInternalRangeRequest request =
       DeleteInternalRangeRequest.newBuilder()
           .setName(
               InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]").toString())
           .setRequestId("requestId693933066")
           .build();
   internalRangeServiceClient.deleteInternalRangeAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteInternalRangeOperationCallable

      public final OperationCallable<DeleteInternalRangeRequest,com.google.protobuf.Empty,OperationMetadata> deleteInternalRangeOperationCallable()
      Deletes a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   DeleteInternalRangeRequest request =
       DeleteInternalRangeRequest.newBuilder()
           .setName(
               InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       internalRangeServiceClient.deleteInternalRangeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteInternalRangeCallable

      public final UnaryCallable<DeleteInternalRangeRequest,Operation> deleteInternalRangeCallable()
      Deletes a single internal range.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   DeleteInternalRangeRequest request =
       DeleteInternalRangeRequest.newBuilder()
           .setName(
               InternalRangeName.of("[PROJECT]", "[LOCATION]", "[INTERNAL_RANGE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       internalRangeServiceClient.deleteInternalRangeCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • listLocations

      public final InternalRangeServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : internalRangeServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listLocationsPagedCallable

      public final UnaryCallable<ListLocationsRequest,InternalRangeServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       internalRangeServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         internalRangeServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getLocation

      public final Location getLocation(GetLocationRequest request)
      Gets information about a 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = internalRangeServiceClient.getLocation(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
      Gets information about a 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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       internalRangeServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

    • setIamPolicy

      public final Policy setIamPolicy(SetIamPolicyRequest request)
      Sets the access control policy on the specified resource. Replacesany existing policy.

      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = internalRangeServiceClient.setIamPolicy(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • setIamPolicyCallable

      public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
      Sets the access control policy on the specified resource. Replacesany existing policy.

      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       internalRangeServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • getIamPolicy

      public final Policy getIamPolicy(GetIamPolicyRequest request)
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = internalRangeServiceClient.getIamPolicy(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getIamPolicyCallable

      public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       internalRangeServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • testIamPermissions

      public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
      Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

      Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = internalRangeServiceClient.testIamPermissions(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • testIamPermissionsCallable

      public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
      Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

      Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

      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 (InternalRangeServiceClient internalRangeServiceClient =
     InternalRangeServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       internalRangeServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException