- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class SslCertificatesClient implements BackgroundResourceService Description: The SslCertificates API.
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:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
String project = "project-309310695";
String sslCertificate = "sslCertificate-1304941589";
SslCertificate response = sslCertificatesClient.get(project, sslCertificate);
}
Note: close() needs to be called on the SslCertificatesClient 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 SslCertificatesSettings to create(). For example:
To customize credentials:
SslCertificatesSettings sslCertificatesSettings =
SslCertificatesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SslCertificatesClient sslCertificatesClient =
SslCertificatesClient.create(sslCertificatesSettings);
To customize the endpoint:
SslCertificatesSettings sslCertificatesSettings =
SslCertificatesSettings.newBuilder().setEndpoint(myEndpoint).build();
SslCertificatesClient sslCertificatesClient =
SslCertificatesClient.create(sslCertificatesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final SslCertificatesClient create()Constructs an instance of SslCertificatesClient with default settings.
| Type | Description |
| SslCertificatesClient |
| Type | Description |
| IOException |
create(SslCertificatesSettings settings)
public static final SslCertificatesClient create(SslCertificatesSettings settings)Constructs an instance of SslCertificatesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Name | Description |
| settings | SslCertificatesSettings |
| Type | Description |
| SslCertificatesClient |
| Type | Description |
| IOException |
create(SslCertificatesStub stub)
public static final SslCertificatesClient create(SslCertificatesStub stub)Constructs an instance of SslCertificatesClient, using the given stub for making calls. This is for advanced usage - prefer using create(SslCertificatesSettings).
| Name | Description |
| stub | SslCertificatesStub |
| Type | Description |
| SslCertificatesClient |
Constructors
SslCertificatesClient(SslCertificatesSettings settings)
protected SslCertificatesClient(SslCertificatesSettings settings)Constructs an instance of SslCertificatesClient, 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.
| Name | Description |
| settings | SslCertificatesSettings |
SslCertificatesClient(SslCertificatesStub stub)
protected SslCertificatesClient(SslCertificatesStub stub)| Name | Description |
| stub | SslCertificatesStub |
Methods
aggregatedList(AggregatedListSslCertificatesRequest request)
public final SslCertificatesClient.AggregatedListPagedResponse aggregatedList(AggregatedListSslCertificatesRequest request)Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
AggregatedListSslCertificatesRequest request =
AggregatedListSslCertificatesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
for (Map.Entry| Name | Description |
| request | AggregatedListSslCertificatesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| SslCertificatesClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final SslCertificatesClient.AggregatedListPagedResponse aggregatedList(String project)Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
String project = "project-309310695";
for (Map.Entry| Name | Description |
| project | StringName of the project scoping this request. |
| Type | Description |
| SslCertificatesClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListSslCertificatesRequest,SslCertificateAggregatedList> aggregatedListCallable()Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
AggregatedListSslCertificatesRequest request =
AggregatedListSslCertificatesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
while (true) {
SslCertificateAggregatedList response =
sslCertificatesClient.aggregatedListCallable().call(request);
for (Map.Entry| Type | Description |
| UnaryCallable<AggregatedListSslCertificatesRequest,SslCertificateAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListSslCertificatesRequest,SslCertificatesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
AggregatedListSslCertificatesRequest request =
AggregatedListSslCertificatesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
ApiFuture<>| Type | Description |
| UnaryCallable<AggregatedListSslCertificatesRequest,AggregatedListPagedResponse> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Name | Description |
| duration | long |
| unit | TimeUnit |
| Type | Description |
| boolean |
| Type | Description |
| InterruptedException |
close()
public final void close()deleteAsync(DeleteSslCertificateRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteSslCertificateRequest request)Deletes the specified SslCertificate resource.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
DeleteSslCertificateRequest request =
DeleteSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setSslCertificate("sslCertificate-1304941589")
.build();
Operation response = sslCertificatesClient.deleteAsync(request).get();
}
| Name | Description |
| request | DeleteSslCertificateRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Operation,Operation> |
deleteAsync(String project, String sslCertificate)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String sslCertificate)Deletes the specified SslCertificate resource.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
String project = "project-309310695";
String sslCertificate = "sslCertificate-1304941589";
Operation response = sslCertificatesClient.deleteAsync(project, sslCertificate).get();
}
| Name | Description |
| project | StringProject ID for this request. |
| sslCertificate | StringName of the SslCertificate resource to delete. |
| Type | Description |
| OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteSslCertificateRequest,Operation> deleteCallable()Deletes the specified SslCertificate resource.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
DeleteSslCertificateRequest request =
DeleteSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setSslCertificate("sslCertificate-1304941589")
.build();
ApiFuture<Operation> future = sslCertificatesClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<DeleteSslCertificateRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteSslCertificateRequest,Operation,Operation> deleteOperationCallable()Deletes the specified SslCertificate resource.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
DeleteSslCertificateRequest request =
DeleteSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setSslCertificate("sslCertificate-1304941589")
.build();
OperationFuture| Type | Description |
| OperationCallable<DeleteSslCertificateRequest,Operation,Operation> |
get(GetSslCertificateRequest request)
public final SslCertificate get(GetSslCertificateRequest request)Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
GetSslCertificateRequest request =
GetSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setSslCertificate("sslCertificate-1304941589")
.build();
SslCertificate response = sslCertificatesClient.get(request);
}
| Name | Description |
| request | GetSslCertificateRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| SslCertificate |
get(String project, String sslCertificate)
public final SslCertificate get(String project, String sslCertificate)Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
String project = "project-309310695";
String sslCertificate = "sslCertificate-1304941589";
SslCertificate response = sslCertificatesClient.get(project, sslCertificate);
}
| Name | Description |
| project | StringProject ID for this request. |
| sslCertificate | StringName of the SslCertificate resource to return. |
| Type | Description |
| SslCertificate |
getCallable()
public final UnaryCallable<GetSslCertificateRequest,SslCertificate> getCallable()Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
GetSslCertificateRequest request =
GetSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setSslCertificate("sslCertificate-1304941589")
.build();
ApiFuture| Type | Description |
| UnaryCallable<GetSslCertificateRequest,SslCertificate> |
getSettings()
public final SslCertificatesSettings getSettings()| Type | Description |
| SslCertificatesSettings |
getStub()
public SslCertificatesStub getStub()| Type | Description |
| SslCertificatesStub |
insertAsync(InsertSslCertificateRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertSslCertificateRequest request)Creates a SslCertificate resource in the specified project using the data included in the request.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
InsertSslCertificateRequest request =
InsertSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setSslCertificateResource(SslCertificate.newBuilder().build())
.build();
Operation response = sslCertificatesClient.insertAsync(request).get();
}
| Name | Description |
| request | InsertSslCertificateRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Operation,Operation> |
insertAsync(String project, SslCertificate sslCertificateResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, SslCertificate sslCertificateResource)Creates a SslCertificate resource in the specified project using the data included in the request.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
String project = "project-309310695";
SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
Operation response = sslCertificatesClient.insertAsync(project, sslCertificateResource).get();
}
| Name | Description |
| project | StringProject ID for this request. |
| sslCertificateResource | SslCertificateThe body resource for this request |
| Type | Description |
| OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertSslCertificateRequest,Operation> insertCallable()Creates a SslCertificate resource in the specified project using the data included in the request.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
InsertSslCertificateRequest request =
InsertSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setSslCertificateResource(SslCertificate.newBuilder().build())
.build();
ApiFuture<Operation> future = sslCertificatesClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<InsertSslCertificateRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertSslCertificateRequest,Operation,Operation> insertOperationCallable()Creates a SslCertificate resource in the specified project using the data included in the request.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
InsertSslCertificateRequest request =
InsertSslCertificateRequest.newBuilder()
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setSslCertificateResource(SslCertificate.newBuilder().build())
.build();
OperationFuture| Type | Description |
| OperationCallable<InsertSslCertificateRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()| Type | Description |
| boolean |
isTerminated()
public boolean isTerminated()| Type | Description |
| boolean |
list(ListSslCertificatesRequest request)
public final SslCertificatesClient.ListPagedResponse list(ListSslCertificatesRequest request)Retrieves the list of SslCertificate resources available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
ListSslCertificatesRequest request =
ListSslCertificatesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
for (SslCertificate element : sslCertificatesClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListSslCertificatesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| SslCertificatesClient.ListPagedResponse |
list(String project)
public final SslCertificatesClient.ListPagedResponse list(String project)Retrieves the list of SslCertificate resources available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
String project = "project-309310695";
for (SslCertificate element : sslCertificatesClient.list(project).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| project | StringProject ID for this request. |
| Type | Description |
| SslCertificatesClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListSslCertificatesRequest,SslCertificateList> listCallable()Retrieves the list of SslCertificate resources available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
ListSslCertificatesRequest request =
ListSslCertificatesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
while (true) {
SslCertificateList response = sslCertificatesClient.listCallable().call(request);
for (SslCertificate element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListSslCertificatesRequest,SslCertificateList> |
listPagedCallable()
public final UnaryCallable<ListSslCertificatesRequest,SslCertificatesClient.ListPagedResponse> listPagedCallable()Retrieves the list of SslCertificate resources available to the specified project.
Sample code:
try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
ListSslCertificatesRequest request =
ListSslCertificatesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
ApiFuture| Type | Description |
| UnaryCallable<ListSslCertificatesRequest,ListPagedResponse> |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()