Class AuthorizedCertificatesClient (2.28.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.78.0 (latest)
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.4
- 2.2.0
- 2.1.10
- 0.2.0
publicclass AuthorizedCertificatesClientimplementsBackgroundResourceService Description: Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
GetAuthorizedCertificateRequestrequest=
GetAuthorizedCertificateRequest.newBuilder()
.setName("name3373707")
.setView(AuthorizedCertificateView.forNumber(0))
.build();
AuthorizedCertificateresponse=
authorizedCertificatesClient.getAuthorizedCertificate(request);
}
Note: close() needs to be called on the AuthorizedCertificatesClient 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 AuthorizedCertificatesSettings 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
AuthorizedCertificatesSettingsauthorizedCertificatesSettings=
AuthorizedCertificatesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create(authorizedCertificatesSettings);
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
AuthorizedCertificatesSettingsauthorizedCertificatesSettings=
AuthorizedCertificatesSettings.newBuilder().setEndpoint(myEndpoint).build();
AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create(authorizedCertificatesSettings);
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
AuthorizedCertificatesSettingsauthorizedCertificatesSettings=
AuthorizedCertificatesSettings.newHttpJsonBuilder().build();
AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create(authorizedCertificatesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceInherited Members
Static Methods
create()
publicstaticfinalAuthorizedCertificatesClientcreate()Constructs an instance of AuthorizedCertificatesClient with default settings.
| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificatesClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(AuthorizedCertificatesSettings settings)
publicstaticfinalAuthorizedCertificatesClientcreate(AuthorizedCertificatesSettingssettings)Constructs an instance of AuthorizedCertificatesClient, 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 |
AuthorizedCertificatesSettings |
| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificatesClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(AuthorizedCertificatesStub stub)
publicstaticfinalAuthorizedCertificatesClientcreate(AuthorizedCertificatesStubstub)Constructs an instance of AuthorizedCertificatesClient, using the given stub for making calls. This is for advanced usage - prefer using create(AuthorizedCertificatesSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
AuthorizedCertificatesStub |
| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificatesClient |
|
Constructors
AuthorizedCertificatesClient(AuthorizedCertificatesSettings settings)
protectedAuthorizedCertificatesClient(AuthorizedCertificatesSettingssettings)Constructs an instance of AuthorizedCertificatesClient, 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 |
AuthorizedCertificatesSettings |
AuthorizedCertificatesClient(AuthorizedCertificatesStub stub)
protectedAuthorizedCertificatesClient(AuthorizedCertificatesStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
AuthorizedCertificatesStub |
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()createAuthorizedCertificate(CreateAuthorizedCertificateRequest request)
publicfinalAuthorizedCertificatecreateAuthorizedCertificate(CreateAuthorizedCertificateRequestrequest)Uploads the specified SSL certificate.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
CreateAuthorizedCertificateRequestrequest=
CreateAuthorizedCertificateRequest.newBuilder()
.setParent("parent-995424086")
.setCertificate(AuthorizedCertificate.newBuilder().build())
.build();
AuthorizedCertificateresponse=
authorizedCertificatesClient.createAuthorizedCertificate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateAuthorizedCertificateRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificate |
|
createAuthorizedCertificateCallable()
publicfinalUnaryCallable<CreateAuthorizedCertificateRequest,AuthorizedCertificate>createAuthorizedCertificateCallable()Uploads the specified SSL certificate.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
CreateAuthorizedCertificateRequestrequest=
CreateAuthorizedCertificateRequest.newBuilder()
.setParent("parent-995424086")
.setCertificate(AuthorizedCertificate.newBuilder().build())
.build();
ApiFuture<AuthorizedCertificate>future=
authorizedCertificatesClient.createAuthorizedCertificateCallable().futureCall(request);
// Do something.
AuthorizedCertificateresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateAuthorizedCertificateRequest,AuthorizedCertificate> |
|
deleteAuthorizedCertificate(DeleteAuthorizedCertificateRequest request)
publicfinalvoiddeleteAuthorizedCertificate(DeleteAuthorizedCertificateRequestrequest)Deletes the specified SSL certificate.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
DeleteAuthorizedCertificateRequestrequest=
DeleteAuthorizedCertificateRequest.newBuilder().setName("name3373707").build();
authorizedCertificatesClient.deleteAuthorizedCertificate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteAuthorizedCertificateRequest The request object containing all of the parameters for the API call. |
deleteAuthorizedCertificateCallable()
publicfinalUnaryCallable<DeleteAuthorizedCertificateRequest,Empty>deleteAuthorizedCertificateCallable()Deletes the specified SSL certificate.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
DeleteAuthorizedCertificateRequestrequest=
DeleteAuthorizedCertificateRequest.newBuilder().setName("name3373707").build();
ApiFuture<Empty>future=
authorizedCertificatesClient.deleteAuthorizedCertificateCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteAuthorizedCertificateRequest,Empty> |
|
getAuthorizedCertificate(GetAuthorizedCertificateRequest request)
publicfinalAuthorizedCertificategetAuthorizedCertificate(GetAuthorizedCertificateRequestrequest)Gets the specified SSL certificate.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
GetAuthorizedCertificateRequestrequest=
GetAuthorizedCertificateRequest.newBuilder()
.setName("name3373707")
.setView(AuthorizedCertificateView.forNumber(0))
.build();
AuthorizedCertificateresponse=
authorizedCertificatesClient.getAuthorizedCertificate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetAuthorizedCertificateRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificate |
|
getAuthorizedCertificateCallable()
publicfinalUnaryCallable<GetAuthorizedCertificateRequest,AuthorizedCertificate>getAuthorizedCertificateCallable()Gets the specified SSL certificate.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
GetAuthorizedCertificateRequestrequest=
GetAuthorizedCertificateRequest.newBuilder()
.setName("name3373707")
.setView(AuthorizedCertificateView.forNumber(0))
.build();
ApiFuture<AuthorizedCertificate>future=
authorizedCertificatesClient.getAuthorizedCertificateCallable().futureCall(request);
// Do something.
AuthorizedCertificateresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAuthorizedCertificateRequest,AuthorizedCertificate> |
|
getSettings()
publicfinalAuthorizedCertificatesSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificatesSettings |
|
getStub()
publicAuthorizedCertificatesStubgetStub()| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificatesStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listAuthorizedCertificates(ListAuthorizedCertificatesRequest request)
publicfinalAuthorizedCertificatesClient.ListAuthorizedCertificatesPagedResponselistAuthorizedCertificates(ListAuthorizedCertificatesRequestrequest)Lists all SSL certificates the user is authorized to administer.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
ListAuthorizedCertificatesRequestrequest=
ListAuthorizedCertificatesRequest.newBuilder()
.setParent("parent-995424086")
.setView(AuthorizedCertificateView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(AuthorizedCertificateelement:
authorizedCertificatesClient.listAuthorizedCertificates(request).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListAuthorizedCertificatesRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificatesClient.ListAuthorizedCertificatesPagedResponse |
|
listAuthorizedCertificatesCallable()
publicfinalUnaryCallable<ListAuthorizedCertificatesRequest,ListAuthorizedCertificatesResponse>listAuthorizedCertificatesCallable()Lists all SSL certificates the user is authorized to administer.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
ListAuthorizedCertificatesRequestrequest=
ListAuthorizedCertificatesRequest.newBuilder()
.setParent("parent-995424086")
.setView(AuthorizedCertificateView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListAuthorizedCertificatesResponseresponse=
authorizedCertificatesClient.listAuthorizedCertificatesCallable().call(request);
for(AuthorizedCertificateelement:response.getCertificatesList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAuthorizedCertificatesRequest,ListAuthorizedCertificatesResponse> |
|
listAuthorizedCertificatesPagedCallable()
publicfinalUnaryCallable<ListAuthorizedCertificatesRequest,AuthorizedCertificatesClient.ListAuthorizedCertificatesPagedResponse>listAuthorizedCertificatesPagedCallable()Lists all SSL certificates the user is authorized to administer.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
ListAuthorizedCertificatesRequestrequest=
ListAuthorizedCertificatesRequest.newBuilder()
.setParent("parent-995424086")
.setView(AuthorizedCertificateView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<AuthorizedCertificate>future=
authorizedCertificatesClient
.listAuthorizedCertificatesPagedCallable()
.futureCall(request);
// Do something.
for(AuthorizedCertificateelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAuthorizedCertificatesRequest,ListAuthorizedCertificatesPagedResponse> |
|
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()updateAuthorizedCertificate(UpdateAuthorizedCertificateRequest request)
publicfinalAuthorizedCertificateupdateAuthorizedCertificate(UpdateAuthorizedCertificateRequestrequest)Updates the specified SSL certificate. To renew a certificate and maintain its existing domain
mappings, update certificate_data with a new certificate. The new certificate must be
applicable to the same domains as the original certificate. The certificate display_name may
also be updated.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
UpdateAuthorizedCertificateRequestrequest=
UpdateAuthorizedCertificateRequest.newBuilder()
.setName("name3373707")
.setCertificate(AuthorizedCertificate.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
AuthorizedCertificateresponse=
authorizedCertificatesClient.updateAuthorizedCertificate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateAuthorizedCertificateRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AuthorizedCertificate |
|
updateAuthorizedCertificateCallable()
publicfinalUnaryCallable<UpdateAuthorizedCertificateRequest,AuthorizedCertificate>updateAuthorizedCertificateCallable()Updates the specified SSL certificate. To renew a certificate and maintain its existing domain
mappings, update certificate_data with a new certificate. The new certificate must be
applicable to the same domains as the original certificate. The certificate display_name may
also be updated.
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(AuthorizedCertificatesClientauthorizedCertificatesClient=
AuthorizedCertificatesClient.create()){
UpdateAuthorizedCertificateRequestrequest=
UpdateAuthorizedCertificateRequest.newBuilder()
.setName("name3373707")
.setCertificate(AuthorizedCertificate.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<AuthorizedCertificate>future=
authorizedCertificatesClient.updateAuthorizedCertificateCallable().futureCall(request);
// Do something.
AuthorizedCertificateresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateAuthorizedCertificateRequest,AuthorizedCertificate> |
|