Class ConfidentialComputingClient (0.40.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 0.64.0 (latest)
- 0.62.0
- 0.61.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.54.0
- 0.53.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Service Description: Service describing handlers for resources
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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
Challengechallenge=Challenge.newBuilder().build();
Challengeresponse=confidentialComputingClient.createChallenge(parent,challenge);
}
Note: close() needs to be called on the ConfidentialComputingClient 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 |
|---|---|---|
CreateChallenge |
Creates a new Challenge 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.
|
VerifyAttestation |
Verifies the provided attestation info, returning a signed OIDC token. |
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.
|
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.
|
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 ConfidentialComputingSettings 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
ConfidentialComputingSettingsconfidentialComputingSettings=
ConfidentialComputingSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create(confidentialComputingSettings);
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
ConfidentialComputingSettingsconfidentialComputingSettings=
ConfidentialComputingSettings.newBuilder().setEndpoint(myEndpoint).build();
ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create(confidentialComputingSettings);
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
ConfidentialComputingSettingsconfidentialComputingSettings=
ConfidentialComputingSettings.newHttpJsonBuilder().build();
ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create(confidentialComputingSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
publicstaticfinalConfidentialComputingClientcreate()Constructs an instance of ConfidentialComputingClient with default settings.
| Returns | |
|---|---|
| Type | Description |
ConfidentialComputingClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(ConfidentialComputingSettings settings)
publicstaticfinalConfidentialComputingClientcreate(ConfidentialComputingSettingssettings)Constructs an instance of ConfidentialComputingClient, 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 |
ConfidentialComputingSettings |
| Returns | |
|---|---|
| Type | Description |
ConfidentialComputingClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(ConfidentialComputingStub stub)
publicstaticfinalConfidentialComputingClientcreate(ConfidentialComputingStubstub)Constructs an instance of ConfidentialComputingClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConfidentialComputingSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
ConfidentialComputingStub |
| Returns | |
|---|---|
| Type | Description |
ConfidentialComputingClient |
|
Constructors
ConfidentialComputingClient(ConfidentialComputingSettings settings)
protectedConfidentialComputingClient(ConfidentialComputingSettingssettings)Constructs an instance of ConfidentialComputingClient, 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 |
ConfidentialComputingSettings |
ConfidentialComputingClient(ConfidentialComputingStub stub)
protectedConfidentialComputingClient(ConfidentialComputingStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
ConfidentialComputingStub |
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()createChallenge(CreateChallengeRequest request)
publicfinalChallengecreateChallenge(CreateChallengeRequestrequest)Creates a new Challenge 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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
CreateChallengeRequestrequest=
CreateChallengeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setChallenge(Challenge.newBuilder().build())
.build();
Challengeresponse=confidentialComputingClient.createChallenge(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateChallengeRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Challenge |
|
createChallenge(LocationName parent, Challenge challenge)
publicfinalChallengecreateChallenge(LocationNameparent,Challengechallenge)Creates a new Challenge 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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
Challengechallenge=Challenge.newBuilder().build();
Challengeresponse=confidentialComputingClient.createChallenge(parent,challenge);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
LocationName Required. The resource name of the location where the Challenge will be used, in
the format |
challenge |
Challenge Required. The Challenge to be created. Currently this field can be empty as all the Challenge fields are set by the server. |
| Returns | |
|---|---|
| Type | Description |
Challenge |
|
createChallenge(String parent, Challenge challenge)
publicfinalChallengecreateChallenge(Stringparent,Challengechallenge)Creates a new Challenge 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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
Stringparent=LocationName.of("[PROJECT]","[LOCATION]").toString();
Challengechallenge=Challenge.newBuilder().build();
Challengeresponse=confidentialComputingClient.createChallenge(parent,challenge);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
String Required. The resource name of the location where the Challenge will be used, in
the format |
challenge |
Challenge Required. The Challenge to be created. Currently this field can be empty as all the Challenge fields are set by the server. |
| Returns | |
|---|---|
| Type | Description |
Challenge |
|
createChallengeCallable()
publicfinalUnaryCallable<CreateChallengeRequest,Challenge>createChallengeCallable()Creates a new Challenge 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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
CreateChallengeRequestrequest=
CreateChallengeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setChallenge(Challenge.newBuilder().build())
.build();
ApiFuture<Challenge>future=
confidentialComputingClient.createChallengeCallable().futureCall(request);
// Do something.
Challengeresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateChallengeRequest,Challenge> |
|
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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
GetLocationRequestrequest=GetLocationRequest.newBuilder().setName("name3373707").build();
Locationresponse=confidentialComputingClient.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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
GetLocationRequestrequest=GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location>future=
confidentialComputingClient.getLocationCallable().futureCall(request);
// Do something.
Locationresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getSettings()
publicfinalConfidentialComputingSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
ConfidentialComputingSettings |
|
getStub()
publicConfidentialComputingStubgetStub()| Returns | |
|---|---|
| Type | Description |
ConfidentialComputingStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listLocations(ListLocationsRequest request)
publicfinalConfidentialComputingClient.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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(Locationelement:confidentialComputingClient.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 |
ConfidentialComputingClient.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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListLocationsResponseresponse=
confidentialComputingClient.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,ConfidentialComputingClient.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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
ListLocationsRequestrequest=
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location>future=
confidentialComputingClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for(Locationelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
|
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()verifyAttestation(VerifyAttestationRequest request)
publicfinalVerifyAttestationResponseverifyAttestation(VerifyAttestationRequestrequest)Verifies the provided attestation info, returning a signed OIDC token.
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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
VerifyAttestationRequestrequest=
VerifyAttestationRequest.newBuilder()
.setChallenge(ChallengeName.of("[PROJECT]","[LOCATION]","[UUID]").toString())
.setGcpCredentials(GcpCredentials.newBuilder().build())
.setTpmAttestation(TpmAttestation.newBuilder().build())
.setConfidentialSpaceInfo(ConfidentialSpaceInfo.newBuilder().build())
.setTokenOptions(TokenOptions.newBuilder().build())
.build();
VerifyAttestationResponseresponse=confidentialComputingClient.verifyAttestation(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
VerifyAttestationRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
VerifyAttestationResponse |
|
verifyAttestationCallable()
publicfinalUnaryCallable<VerifyAttestationRequest,VerifyAttestationResponse>verifyAttestationCallable()Verifies the provided attestation info, returning a signed OIDC token.
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(ConfidentialComputingClientconfidentialComputingClient=
ConfidentialComputingClient.create()){
VerifyAttestationRequestrequest=
VerifyAttestationRequest.newBuilder()
.setChallenge(ChallengeName.of("[PROJECT]","[LOCATION]","[UUID]").toString())
.setGcpCredentials(GcpCredentials.newBuilder().build())
.setTpmAttestation(TpmAttestation.newBuilder().build())
.setConfidentialSpaceInfo(ConfidentialSpaceInfo.newBuilder().build())
.setTokenOptions(TokenOptions.newBuilder().build())
.build();
ApiFuture<VerifyAttestationResponse>future=
confidentialComputingClient.verifyAttestationCallable().futureCall(request);
// Do something.
VerifyAttestationResponseresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<VerifyAttestationRequest,VerifyAttestationResponse> |
|