- 1.69.0 (latest)
- 1.67.0
- 1.66.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.9
- 1.1.1
- 1.0.0
- 0.5.0
GitHub Repository | Product Reference |
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().
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteInternalRange |
Deletes a single internal range. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replacesany existing policy. Can return |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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 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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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.
Static Methods
create()
public static final InternalRangeServiceClient create()
Constructs an instance of InternalRangeServiceClient with default settings.
Returns | |
---|---|
Type | Description |
InternalRangeServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(InternalRangeServiceSettings settings)
public static final InternalRangeServiceClient create(InternalRangeServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
InternalRangeServiceSettings |
Returns | |
---|---|
Type | Description |
InternalRangeServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(InternalRangeServiceStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
InternalRangeServiceStub |
Returns | |
---|---|
Type | Description |
InternalRangeServiceClient |
Constructors
InternalRangeServiceClient(InternalRangeServiceSettings settings)
protected InternalRangeServiceClient(InternalRangeServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
InternalRangeServiceSettings |
InternalRangeServiceClient(InternalRangeServiceStub stub)
protected InternalRangeServiceClient(InternalRangeServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
InternalRangeServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createInternalRangeAsync(CreateInternalRangeRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
CreateInternalRangeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<InternalRange,OperationMetadata> |
createInternalRangeAsync(LocationName parent, InternalRange internalRange, String internalRangeId)
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 | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource's name of the internal range. |
internalRange |
InternalRange Required. Initial values for a new internal range |
internalRangeId |
String 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. |
Returns | |
---|---|
Type | Description |
OperationFuture<InternalRange,OperationMetadata> |
createInternalRangeAsync(String parent, InternalRange internalRange, String internalRangeId)
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 | |
---|---|
Name | Description |
parent |
String Required. The parent resource's name of the internal range. |
internalRange |
InternalRange Required. Initial values for a new internal range |
internalRangeId |
String 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. |
Returns | |
---|---|
Type | Description |
OperationFuture<InternalRange,OperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateInternalRangeRequest,Operation> |
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateInternalRangeRequest,InternalRange,OperationMetadata> |
deleteInternalRangeAsync(DeleteInternalRangeRequest request)
public final OperationFuture<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();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteInternalRangeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInternalRangeAsync(InternalRangeName name)
public final OperationFuture<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();
}
Parameter | |
---|---|
Name | Description |
name |
InternalRangeName Required. The name of the internal range to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteInternalRangeAsync(String name)
public final OperationFuture<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();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the internal range to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteInternalRangeRequest,Operation> |
deleteInternalRangeOperationCallable()
public final OperationCallable<DeleteInternalRangeRequest,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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteInternalRangeRequest,Empty,OperationMetadata> |
getIamPolicy(GetIamPolicyRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getInternalRange(GetInternalRangeRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
GetInternalRangeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
InternalRange |
getInternalRange(InternalRangeName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
InternalRangeName Required. Name of the InternalRange to get. |
Returns | |
---|---|
Type | Description |
InternalRange |
getInternalRange(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Name of the InternalRange to get. |
Returns | |
---|---|
Type | Description |
InternalRange |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetInternalRangeRequest,InternalRange> |
getLocation(GetLocationRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getSettings()
public final InternalRangeServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
InternalRangeServiceSettings |
getStub()
public InternalRangeServiceStub getStub()
Returns | |
---|---|
Type | Description |
InternalRangeServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listInternalRanges(ListInternalRangesRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListInternalRangesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
InternalRangeServiceClient.ListInternalRangesPagedResponse |
listInternalRanges(LocationName parent)
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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. The parent resource's name. |
Returns | |
---|---|
Type | Description |
InternalRangeServiceClient.ListInternalRangesPagedResponse |
listInternalRanges(String parent)
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);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The parent resource's name. |
Returns | |
---|---|
Type | Description |
InternalRangeServiceClient.ListInternalRangesPagedResponse |
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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListInternalRangesRequest,ListInternalRangesResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListInternalRangesRequest,ListInternalRangesPagedResponse> |
listLocations(ListLocationsRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
InternalRangeServiceClient.ListLocationsPagedResponse |
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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateInternalRangeAsync(InternalRange internalRange, FieldMask updateMask)
public final OperationFuture<InternalRange,OperationMetadata> updateInternalRangeAsync(InternalRange internalRange, 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 | |
---|---|
Name | Description |
internalRange |
InternalRange Required. New values to be patched into the resource. |
updateMask |
FieldMask 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. |
Returns | |
---|---|
Type | Description |
OperationFuture<InternalRange,OperationMetadata> |
updateInternalRangeAsync(UpdateInternalRangeRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request |
UpdateInternalRangeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<InternalRange,OperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateInternalRangeRequest,Operation> |
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateInternalRangeRequest,InternalRange,OperationMetadata> |