Class AuthorizedCertificatesClient (2.59.0)

Service 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().

Methods
Method Description Method Variants

ListAuthorizedCertificates

Lists all SSL certificates the user is authorized to administer.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAuthorizedCertificates(ListAuthorizedCertificatesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAuthorizedCertificatesPagedCallable()

  • listAuthorizedCertificatesCallable()

GetAuthorizedCertificate

Gets the specified SSL certificate.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAuthorizedCertificate(GetAuthorizedCertificateRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAuthorizedCertificateCallable()

CreateAuthorizedCertificate

Uploads the specified SSL certificate.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAuthorizedCertificate(CreateAuthorizedCertificateRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAuthorizedCertificateCallable()

UpdateAuthorizedCertificate

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAuthorizedCertificate(UpdateAuthorizedCertificateRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAuthorizedCertificateCallable()

DeleteAuthorizedCertificate

Deletes the specified SSL certificate.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAuthorizedCertificate(DeleteAuthorizedCertificateRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAuthorizedCertificateCallable()

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.

Inheritance

java.lang.Object > AuthorizedCertificatesClient

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>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.