public class ConfidentialComputingClient implements BackgroundResource
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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Challenge challenge = Challenge.newBuilder().build();
Challenge response = 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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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
ConfidentialComputingSettings confidentialComputingSettings =
ConfidentialComputingSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ConfidentialComputingClient confidentialComputingClient =
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
ConfidentialComputingSettings confidentialComputingSettings =
ConfidentialComputingSettings.newBuilder().setEndpoint(myEndpoint).build();
ConfidentialComputingClient confidentialComputingClient =
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
ConfidentialComputingSettings confidentialComputingSettings =
ConfidentialComputingSettings.newHttpJsonBuilder().build();
ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create(confidentialComputingSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final ConfidentialComputingClient create()
Constructs an instance of ConfidentialComputingClient with default settings.
Returns | |
---|---|
Type | Description |
ConfidentialComputingClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ConfidentialComputingSettings settings)
public static final ConfidentialComputingClient create(ConfidentialComputingSettings settings)
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)
public static final ConfidentialComputingClient create(ConfidentialComputingStub stub)
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)
protected ConfidentialComputingClient(ConfidentialComputingSettings settings)
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)
protected ConfidentialComputingClient(ConfidentialComputingStub stub)
Parameter | |
---|---|
Name | Description |
stub | ConfidentialComputingStub |
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()
createChallenge(CreateChallengeRequest request)
public final Challenge createChallenge(CreateChallengeRequest request)
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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
CreateChallengeRequest request =
CreateChallengeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setChallenge(Challenge.newBuilder().build())
.build();
Challenge response = 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)
public final Challenge createChallenge(LocationName parent, Challenge challenge)
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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Challenge challenge = Challenge.newBuilder().build();
Challenge response = 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)
public final Challenge createChallenge(String parent, Challenge challenge)
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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Challenge challenge = Challenge.newBuilder().build();
Challenge response = 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()
public final UnaryCallable<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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
CreateChallengeRequest request =
CreateChallengeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setChallenge(Challenge.newBuilder().build())
.build();
ApiFuture<Challenge> future =
confidentialComputingClient.createChallengeCallable().futureCall(request);
// Do something.
Challenge response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateChallengeRequest,Challenge> |
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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = confidentialComputingClient.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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future =
confidentialComputingClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final ConfidentialComputingSettings getSettings()
Returns | |
---|---|
Type | Description |
ConfidentialComputingSettings |
getStub()
public ConfidentialComputingStub getStub()
Returns | |
---|---|
Type | Description |
ConfidentialComputingStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
public final ConfidentialComputingClient.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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : confidentialComputingClient.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 |
ConfidentialComputingClient.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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
confidentialComputingClient.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,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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
confidentialComputingClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
verifyAttestation(VerifyAttestationRequest request)
public final VerifyAttestationResponse verifyAttestation(VerifyAttestationRequest request)
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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
VerifyAttestationRequest request =
VerifyAttestationRequest.newBuilder()
.setChallenge(ChallengeName.of("[PROJECT]", "[LOCATION]", "[UUID]").toString())
.setGcpCredentials(GcpCredentials.newBuilder().build())
.setTpmAttestation(TpmAttestation.newBuilder().build())
.build();
VerifyAttestationResponse response = 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()
public final UnaryCallable<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 (ConfidentialComputingClient confidentialComputingClient =
ConfidentialComputingClient.create()) {
VerifyAttestationRequest request =
VerifyAttestationRequest.newBuilder()
.setChallenge(ChallengeName.of("[PROJECT]", "[LOCATION]", "[UUID]").toString())
.setGcpCredentials(GcpCredentials.newBuilder().build())
.setTpmAttestation(TpmAttestation.newBuilder().build())
.build();
ApiFuture<VerifyAttestationResponse> future =
confidentialComputingClient.verifyAttestationCallable().futureCall(request);
// Do something.
VerifyAttestationResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<VerifyAttestationRequest,VerifyAttestationResponse> |