Class LlmUtilityServiceClient (0.6.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicclass LlmUtilityServiceClientimplementsBackgroundResourceService Description: Service for LLM related utility functions.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
EndpointNameendpoint=
EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]");
List<Value>instances=newArrayList<>();
CountTokensResponseresponse=llmUtilityServiceClient.countTokens(endpoint,instances);
}
Note: close() needs to be called on the LlmUtilityServiceClient 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 |
|---|---|---|
CountTokens |
Perform a token counting. |
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.
|
ComputeTokens |
Return a list of tokens based on the input text. |
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.
|
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 LlmUtilityServiceSettings 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
LlmUtilityServiceSettingsllmUtilityServiceSettings=
LlmUtilityServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
LlmUtilityServiceClientllmUtilityServiceClient=
LlmUtilityServiceClient.create(llmUtilityServiceSettings);
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
LlmUtilityServiceSettingsllmUtilityServiceSettings=
LlmUtilityServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
LlmUtilityServiceClientllmUtilityServiceClient=
LlmUtilityServiceClient.create(llmUtilityServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
LlmUtilityServiceSettingsllmUtilityServiceSettings=
LlmUtilityServiceSettings.newHttpJsonBuilder().build();
LlmUtilityServiceClientllmUtilityServiceClient=
LlmUtilityServiceClient.create(llmUtilityServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceInherited Members
Static Methods
create()
publicstaticfinalLlmUtilityServiceClientcreate()Constructs an instance of LlmUtilityServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
LlmUtilityServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(LlmUtilityServiceSettings settings)
publicstaticfinalLlmUtilityServiceClientcreate(LlmUtilityServiceSettingssettings)Constructs an instance of LlmUtilityServiceClient, 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 |
LlmUtilityServiceSettings |
| Returns | |
|---|---|
| Type | Description |
LlmUtilityServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(LlmUtilityServiceStub stub)
publicstaticfinalLlmUtilityServiceClientcreate(LlmUtilityServiceStubstub)Constructs an instance of LlmUtilityServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(LlmUtilityServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
LlmUtilityServiceStub |
| Returns | |
|---|---|
| Type | Description |
LlmUtilityServiceClient |
|
Constructors
LlmUtilityServiceClient(LlmUtilityServiceSettings settings)
protectedLlmUtilityServiceClient(LlmUtilityServiceSettingssettings)Constructs an instance of LlmUtilityServiceClient, 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 |
LlmUtilityServiceSettings |
LlmUtilityServiceClient(LlmUtilityServiceStub stub)
protectedLlmUtilityServiceClient(LlmUtilityServiceStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
LlmUtilityServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
publicfinalvoidclose()computeTokens(ComputeTokensRequest request)
publicfinalComputeTokensResponsecomputeTokens(ComputeTokensRequestrequest)Return a list of tokens based on the input text.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
ComputeTokensRequestrequest=
ComputeTokensRequest.newBuilder()
.setEndpoint(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.addAllInstances(newArrayList<Value>())
.build();
ComputeTokensResponseresponse=llmUtilityServiceClient.computeTokens(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
ComputeTokensRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ComputeTokensResponse |
|
computeTokens(EndpointName endpoint, List<Value> instances)
publicfinalComputeTokensResponsecomputeTokens(EndpointNameendpoint,List<Value>instances)Return a list of tokens based on the input text.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
EndpointNameendpoint=
EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]");
List<Value>instances=newArrayList<>();
ComputeTokensResponseresponse=llmUtilityServiceClient.computeTokens(endpoint,instances);
}
| Parameters | |
|---|---|
| Name | Description |
endpoint |
EndpointName Required. The name of the Endpoint requested to get lists of tokens and token ids. |
instances |
List<Value>Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. |
| Returns | |
|---|---|
| Type | Description |
ComputeTokensResponse |
|
computeTokens(String endpoint, List<Value> instances)
publicfinalComputeTokensResponsecomputeTokens(Stringendpoint,List<Value>instances)Return a list of tokens based on the input text.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
Stringendpoint=
EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString();
List<Value>instances=newArrayList<>();
ComputeTokensResponseresponse=llmUtilityServiceClient.computeTokens(endpoint,instances);
}
| Parameters | |
|---|---|
| Name | Description |
endpoint |
String Required. The name of the Endpoint requested to get lists of tokens and token ids. |
instances |
List<Value>Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. |
| Returns | |
|---|---|
| Type | Description |
ComputeTokensResponse |
|
computeTokensCallable()
publicfinalUnaryCallable<ComputeTokensRequest,ComputeTokensResponse>computeTokensCallable()Return a list of tokens based on the input text.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
ComputeTokensRequestrequest=
ComputeTokensRequest.newBuilder()
.setEndpoint(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.addAllInstances(newArrayList<Value>())
.build();
ApiFuture<ComputeTokensResponse>future=
llmUtilityServiceClient.computeTokensCallable().futureCall(request);
// Do something.
ComputeTokensResponseresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ComputeTokensRequest,ComputeTokensResponse> |
|
countTokens(CountTokensRequest request)
publicfinalCountTokensResponsecountTokens(CountTokensRequestrequest)Perform a token counting.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
CountTokensRequestrequest=
CountTokensRequest.newBuilder()
.setEndpoint(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.setModel("model104069929")
.addAllInstances(newArrayList<Value>())
.addAllContents(newArrayList<Content>())
.build();
CountTokensResponseresponse=llmUtilityServiceClient.countTokens(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CountTokensRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CountTokensResponse |
|
countTokens(EndpointName endpoint, List<Value> instances)
publicfinalCountTokensResponsecountTokens(EndpointNameendpoint,List<Value>instances)Perform a token counting.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
EndpointNameendpoint=
EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]");
List<Value>instances=newArrayList<>();
CountTokensResponseresponse=llmUtilityServiceClient.countTokens(endpoint,instances);
}
| Parameters | |
|---|---|
| Name | Description |
endpoint |
EndpointName Required. The name of the Endpoint requested to perform token counting. Format:
|
instances |
List<Value>Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. |
| Returns | |
|---|---|
| Type | Description |
CountTokensResponse |
|
countTokens(String endpoint, List<Value> instances)
publicfinalCountTokensResponsecountTokens(Stringendpoint,List<Value>instances)Perform a token counting.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
Stringendpoint=
EndpointName.ofProjectLocationEndpointName("[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString();
List<Value>instances=newArrayList<>();
CountTokensResponseresponse=llmUtilityServiceClient.countTokens(endpoint,instances);
}
| Parameters | |
|---|---|
| Name | Description |
endpoint |
String Required. The name of the Endpoint requested to perform token counting. Format:
|
instances |
List<Value>Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. |
| Returns | |
|---|---|
| Type | Description |
CountTokensResponse |
|
countTokensCallable()
publicfinalUnaryCallable<CountTokensRequest,CountTokensResponse>countTokensCallable()Perform a token counting.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
CountTokensRequestrequest=
CountTokensRequest.newBuilder()
.setEndpoint(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.setModel("model104069929")
.addAllInstances(newArrayList<Value>())
.addAllContents(newArrayList<Content>())
.build();
ApiFuture<CountTokensResponse>future=
llmUtilityServiceClient.countTokensCallable().futureCall(request);
// Do something.
CountTokensResponseresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CountTokensRequest,CountTokensResponse> |
|
getIamPolicy(GetIamPolicyRequest request)
publicfinalPolicygetIamPolicy(GetIamPolicyRequestrequest)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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
GetIamPolicyRequestrequest=
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policyresponse=llmUtilityServiceClient.getIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
getIamPolicyCallable()
publicfinalUnaryCallable<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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
GetIamPolicyRequestrequest=
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy>future=llmUtilityServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policyresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getLocation(GetLocationRequest request)
publicfinalLocationgetLocation(GetLocationRequestrequest)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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
GetLocationRequestrequest=GetLocationRequest.newBuilder().setName("name3373707").build();
Locationresponse=llmUtilityServiceClient.getLocation(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.GetLocationRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.location.Location |
|
getLocationCallable()
publicfinalUnaryCallable<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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
GetLocationRequestrequest=GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location>future=
llmUtilityServiceClient.getLocationCallable().futureCall(request);
// Do something.
Locationresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getSettings()
publicfinalLlmUtilityServiceSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
LlmUtilityServiceSettings |
|
getStub()
publicLlmUtilityServiceStubgetStub()| Returns | |
|---|---|
| Type | Description |
LlmUtilityServiceStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listLocations(ListLocationsRequest request)
publicfinalLlmUtilityServiceClient.ListLocationsPagedResponselistLocations(ListLocationsRequestrequest)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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(Locationelement:llmUtilityServiceClient.listLocations(request).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
LlmUtilityServiceClient.ListLocationsPagedResponse |
|
listLocationsCallable()
publicfinalUnaryCallable<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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListLocationsResponseresponse=
llmUtilityServiceClient.listLocationsCallable().call(request);
for(Locationelement:response.getLocationsList()){
// doThingsWith(element);
}
StringnextPageToken=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()
publicfinalUnaryCallable<ListLocationsRequest,LlmUtilityServiceClient.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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location>future=
llmUtilityServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for(Locationelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
|
setIamPolicy(SetIamPolicyRequest request)
publicfinalPolicysetIamPolicy(SetIamPolicyRequestrequest)Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
SetIamPolicyRequestrequest=
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policyresponse=llmUtilityServiceClient.setIamPolicy(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.Policy |
|
setIamPolicyCallable()
publicfinalUnaryCallable<SetIamPolicyRequest,Policy>setIamPolicyCallable()Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.
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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
SetIamPolicyRequestrequest=
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy>future=llmUtilityServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policyresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()testIamPermissions(TestIamPermissionsRequest request)
publicfinalTestIamPermissionsResponsetestIamPermissions(TestIamPermissionsRequestrequest)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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
TestIamPermissionsRequestrequest=
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.addAllPermissions(newArrayList<String>())
.build();
TestIamPermissionsResponseresponse=llmUtilityServiceClient.testIamPermissions(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.iam.v1.TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
|
testIamPermissionsCallable()
publicfinalUnaryCallable<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(LlmUtilityServiceClientllmUtilityServiceClient=LlmUtilityServiceClient.create()){
TestIamPermissionsRequestrequest=
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]","[LOCATION]","[ENDPOINT]")
.toString())
.addAllPermissions(newArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse>future=
llmUtilityServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponseresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|