public class StorageInsightsClient 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ReportConfigName name = ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]");
ReportConfig response = storageInsightsClient.getReportConfig(name);
}
Note: close() needs to be called on the StorageInsightsClient 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 StorageInsightsSettings 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
StorageInsightsSettings storageInsightsSettings =
StorageInsightsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
StorageInsightsClient storageInsightsClient =
StorageInsightsClient.create(storageInsightsSettings);
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
StorageInsightsSettings storageInsightsSettings =
StorageInsightsSettings.newBuilder().setEndpoint(myEndpoint).build();
StorageInsightsClient storageInsightsClient =
StorageInsightsClient.create(storageInsightsSettings);
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
StorageInsightsSettings storageInsightsSettings =
StorageInsightsSettings.newHttpJsonBuilder().build();
StorageInsightsClient storageInsightsClient =
StorageInsightsClient.create(storageInsightsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final StorageInsightsClient create()
Constructs an instance of StorageInsightsClient with default settings.
Returns | |
---|---|
Type | Description |
StorageInsightsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(StorageInsightsSettings settings)
public static final StorageInsightsClient create(StorageInsightsSettings settings)
Constructs an instance of StorageInsightsClient, 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 |
StorageInsightsSettings |
Returns | |
---|---|
Type | Description |
StorageInsightsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(StorageInsightsStub stub)
public static final StorageInsightsClient create(StorageInsightsStub stub)
Constructs an instance of StorageInsightsClient, using the given stub for making calls. This is for advanced usage - prefer using create(StorageInsightsSettings).
Parameter | |
---|---|
Name | Description |
stub |
StorageInsightsStub |
Returns | |
---|---|
Type | Description |
StorageInsightsClient |
Constructors
StorageInsightsClient(StorageInsightsSettings settings)
protected StorageInsightsClient(StorageInsightsSettings settings)
Constructs an instance of StorageInsightsClient, 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 |
StorageInsightsSettings |
StorageInsightsClient(StorageInsightsStub stub)
protected StorageInsightsClient(StorageInsightsStub stub)
Parameter | |
---|---|
Name | Description |
stub |
StorageInsightsStub |
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()
createReportConfig(CreateReportConfigRequest request)
public final ReportConfig createReportConfig(CreateReportConfigRequest request)
Creates a new ReportConfig 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
CreateReportConfigRequest request =
CreateReportConfigRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setReportConfig(ReportConfig.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ReportConfig response = storageInsightsClient.createReportConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
CreateReportConfigRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReportConfig |
createReportConfig(LocationName parent, ReportConfig reportConfig)
public final ReportConfig createReportConfig(LocationName parent, ReportConfig reportConfig)
Creates a new ReportConfig 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
ReportConfig reportConfig = ReportConfig.newBuilder().build();
ReportConfig response = storageInsightsClient.createReportConfig(parent, reportConfig);
}
Parameters | |
---|---|
Name | Description |
parent |
LocationName Required. Value for parent. |
reportConfig |
ReportConfig Required. The resource being created |
Returns | |
---|---|
Type | Description |
ReportConfig |
createReportConfig(String parent, ReportConfig reportConfig)
public final ReportConfig createReportConfig(String parent, ReportConfig reportConfig)
Creates a new ReportConfig 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
ReportConfig reportConfig = ReportConfig.newBuilder().build();
ReportConfig response = storageInsightsClient.createReportConfig(parent, reportConfig);
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. Value for parent. |
reportConfig |
ReportConfig Required. The resource being created |
Returns | |
---|---|
Type | Description |
ReportConfig |
createReportConfigCallable()
public final UnaryCallable<CreateReportConfigRequest,ReportConfig> createReportConfigCallable()
Creates a new ReportConfig 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
CreateReportConfigRequest request =
CreateReportConfigRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setReportConfig(ReportConfig.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<ReportConfig> future =
storageInsightsClient.createReportConfigCallable().futureCall(request);
// Do something.
ReportConfig response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateReportConfigRequest,ReportConfig> |
deleteReportConfig(DeleteReportConfigRequest request)
public final void deleteReportConfig(DeleteReportConfigRequest request)
Deletes a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
DeleteReportConfigRequest request =
DeleteReportConfigRequest.newBuilder()
.setName(ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString())
.setForce(true)
.setRequestId("requestId693933066")
.build();
storageInsightsClient.deleteReportConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteReportConfigRequest The request object containing all of the parameters for the API call. |
deleteReportConfig(ReportConfigName name)
public final void deleteReportConfig(ReportConfigName name)
Deletes a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ReportConfigName name = ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]");
storageInsightsClient.deleteReportConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
ReportConfigName Required. Name of the resource |
deleteReportConfig(String name)
public final void deleteReportConfig(String name)
Deletes a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
String name = ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString();
storageInsightsClient.deleteReportConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Name of the resource |
deleteReportConfigCallable()
public final UnaryCallable<DeleteReportConfigRequest,Empty> deleteReportConfigCallable()
Deletes a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
DeleteReportConfigRequest request =
DeleteReportConfigRequest.newBuilder()
.setName(ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString())
.setForce(true)
.setRequestId("requestId693933066")
.build();
ApiFuture<Empty> future =
storageInsightsClient.deleteReportConfigCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteReportConfigRequest,Empty> |
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = storageInsightsClient.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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = storageInsightsClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getReportConfig(GetReportConfigRequest request)
public final ReportConfig getReportConfig(GetReportConfigRequest request)
Gets details of a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
GetReportConfigRequest request =
GetReportConfigRequest.newBuilder()
.setName(ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString())
.build();
ReportConfig response = storageInsightsClient.getReportConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetReportConfigRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReportConfig |
getReportConfig(ReportConfigName name)
public final ReportConfig getReportConfig(ReportConfigName name)
Gets details of a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ReportConfigName name = ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]");
ReportConfig response = storageInsightsClient.getReportConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
ReportConfigName Required. Name of the resource |
Returns | |
---|---|
Type | Description |
ReportConfig |
getReportConfig(String name)
public final ReportConfig getReportConfig(String name)
Gets details of a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
String name = ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString();
ReportConfig response = storageInsightsClient.getReportConfig(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Name of the resource |
Returns | |
---|---|
Type | Description |
ReportConfig |
getReportConfigCallable()
public final UnaryCallable<GetReportConfigRequest,ReportConfig> getReportConfigCallable()
Gets details of a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
GetReportConfigRequest request =
GetReportConfigRequest.newBuilder()
.setName(ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString())
.build();
ApiFuture<ReportConfig> future =
storageInsightsClient.getReportConfigCallable().futureCall(request);
// Do something.
ReportConfig response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetReportConfigRequest,ReportConfig> |
getReportDetail(GetReportDetailRequest request)
public final ReportDetail getReportDetail(GetReportDetailRequest request)
Gets details of a single ReportDetail.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
GetReportDetailRequest request =
GetReportDetailRequest.newBuilder()
.setName(
ReportDetailName.of(
"[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]", "[REPORT_DETAIL]")
.toString())
.build();
ReportDetail response = storageInsightsClient.getReportDetail(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetReportDetailRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReportDetail |
getReportDetail(ReportDetailName name)
public final ReportDetail getReportDetail(ReportDetailName name)
Gets details of a single ReportDetail.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ReportDetailName name =
ReportDetailName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]", "[REPORT_DETAIL]");
ReportDetail response = storageInsightsClient.getReportDetail(name);
}
Parameter | |
---|---|
Name | Description |
name |
ReportDetailName Required. Name of the resource |
Returns | |
---|---|
Type | Description |
ReportDetail |
getReportDetail(String name)
public final ReportDetail getReportDetail(String name)
Gets details of a single ReportDetail.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
String name =
ReportDetailName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]", "[REPORT_DETAIL]")
.toString();
ReportDetail response = storageInsightsClient.getReportDetail(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. Name of the resource |
Returns | |
---|---|
Type | Description |
ReportDetail |
getReportDetailCallable()
public final UnaryCallable<GetReportDetailRequest,ReportDetail> getReportDetailCallable()
Gets details of a single ReportDetail.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
GetReportDetailRequest request =
GetReportDetailRequest.newBuilder()
.setName(
ReportDetailName.of(
"[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]", "[REPORT_DETAIL]")
.toString())
.build();
ApiFuture<ReportDetail> future =
storageInsightsClient.getReportDetailCallable().futureCall(request);
// Do something.
ReportDetail response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetReportDetailRequest,ReportDetail> |
getSettings()
public final StorageInsightsSettings getSettings()
Returns | |
---|---|
Type | Description |
StorageInsightsSettings |
getStub()
public StorageInsightsStub getStub()
Returns | |
---|---|
Type | Description |
StorageInsightsStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listLocations(ListLocationsRequest request)
public final StorageInsightsClient.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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : storageInsightsClient.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 |
StorageInsightsClient.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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
storageInsightsClient.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,StorageInsightsClient.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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
storageInsightsClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listReportConfigs(ListReportConfigsRequest request)
public final StorageInsightsClient.ListReportConfigsPagedResponse listReportConfigs(ListReportConfigsRequest request)
Lists ReportConfigs 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListReportConfigsRequest request =
ListReportConfigsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (ReportConfig element : storageInsightsClient.listReportConfigs(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListReportConfigsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
StorageInsightsClient.ListReportConfigsPagedResponse |
listReportConfigs(LocationName parent)
public final StorageInsightsClient.ListReportConfigsPagedResponse listReportConfigs(LocationName parent)
Lists ReportConfigs 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (ReportConfig element : storageInsightsClient.listReportConfigs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
LocationName Required. Parent value for ListReportConfigsRequest |
Returns | |
---|---|
Type | Description |
StorageInsightsClient.ListReportConfigsPagedResponse |
listReportConfigs(String parent)
public final StorageInsightsClient.ListReportConfigsPagedResponse listReportConfigs(String parent)
Lists ReportConfigs 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (ReportConfig element : storageInsightsClient.listReportConfigs(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. Parent value for ListReportConfigsRequest |
Returns | |
---|---|
Type | Description |
StorageInsightsClient.ListReportConfigsPagedResponse |
listReportConfigsCallable()
public final UnaryCallable<ListReportConfigsRequest,ListReportConfigsResponse> listReportConfigsCallable()
Lists ReportConfigs 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListReportConfigsRequest request =
ListReportConfigsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListReportConfigsResponse response =
storageInsightsClient.listReportConfigsCallable().call(request);
for (ReportConfig element : response.getReportConfigsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListReportConfigsRequest,ListReportConfigsResponse> |
listReportConfigsPagedCallable()
public final UnaryCallable<ListReportConfigsRequest,StorageInsightsClient.ListReportConfigsPagedResponse> listReportConfigsPagedCallable()
Lists ReportConfigs 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListReportConfigsRequest request =
ListReportConfigsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<ReportConfig> future =
storageInsightsClient.listReportConfigsPagedCallable().futureCall(request);
// Do something.
for (ReportConfig element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListReportConfigsRequest,ListReportConfigsPagedResponse> |
listReportDetails(ListReportDetailsRequest request)
public final StorageInsightsClient.ListReportDetailsPagedResponse listReportDetails(ListReportDetailsRequest request)
Lists ReportDetails 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListReportDetailsRequest request =
ListReportDetailsRequest.newBuilder()
.setParent(
ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (ReportDetail element : storageInsightsClient.listReportDetails(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListReportDetailsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
StorageInsightsClient.ListReportDetailsPagedResponse |
listReportDetails(ReportConfigName parent)
public final StorageInsightsClient.ListReportDetailsPagedResponse listReportDetails(ReportConfigName parent)
Lists ReportDetails 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ReportConfigName parent = ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]");
for (ReportDetail element : storageInsightsClient.listReportDetails(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
ReportConfigName Required. Parent value for ListReportDetailsRequest |
Returns | |
---|---|
Type | Description |
StorageInsightsClient.ListReportDetailsPagedResponse |
listReportDetails(String parent)
public final StorageInsightsClient.ListReportDetailsPagedResponse listReportDetails(String parent)
Lists ReportDetails 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
String parent = ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString();
for (ReportDetail element : storageInsightsClient.listReportDetails(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. Parent value for ListReportDetailsRequest |
Returns | |
---|---|
Type | Description |
StorageInsightsClient.ListReportDetailsPagedResponse |
listReportDetailsCallable()
public final UnaryCallable<ListReportDetailsRequest,ListReportDetailsResponse> listReportDetailsCallable()
Lists ReportDetails 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListReportDetailsRequest request =
ListReportDetailsRequest.newBuilder()
.setParent(
ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListReportDetailsResponse response =
storageInsightsClient.listReportDetailsCallable().call(request);
for (ReportDetail element : response.getReportDetailsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListReportDetailsRequest,ListReportDetailsResponse> |
listReportDetailsPagedCallable()
public final UnaryCallable<ListReportDetailsRequest,StorageInsightsClient.ListReportDetailsPagedResponse> listReportDetailsPagedCallable()
Lists ReportDetails 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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ListReportDetailsRequest request =
ListReportDetailsRequest.newBuilder()
.setParent(
ReportConfigName.of("[PROJECT]", "[LOCATION]", "[REPORT_CONFIG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<ReportDetail> future =
storageInsightsClient.listReportDetailsPagedCallable().futureCall(request);
// Do something.
for (ReportDetail element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListReportDetailsRequest,ListReportDetailsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateReportConfig(ReportConfig reportConfig, FieldMask updateMask)
public final ReportConfig updateReportConfig(ReportConfig reportConfig, FieldMask updateMask)
Updates the parameters of a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
ReportConfig reportConfig = ReportConfig.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ReportConfig response = storageInsightsClient.updateReportConfig(reportConfig, updateMask);
}
Parameters | |
---|---|
Name | Description |
reportConfig |
ReportConfig Required. The resource being updated |
updateMask |
FieldMask Required. Field mask is used to specify the fields to be overwritten in the ReportConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
Returns | |
---|---|
Type | Description |
ReportConfig |
updateReportConfig(UpdateReportConfigRequest request)
public final ReportConfig updateReportConfig(UpdateReportConfigRequest request)
Updates the parameters of a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
UpdateReportConfigRequest request =
UpdateReportConfigRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setReportConfig(ReportConfig.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ReportConfig response = storageInsightsClient.updateReportConfig(request);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateReportConfigRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReportConfig |
updateReportConfigCallable()
public final UnaryCallable<UpdateReportConfigRequest,ReportConfig> updateReportConfigCallable()
Updates the parameters of a single ReportConfig.
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 (StorageInsightsClient storageInsightsClient = StorageInsightsClient.create()) {
UpdateReportConfigRequest request =
UpdateReportConfigRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setReportConfig(ReportConfig.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<ReportConfig> future =
storageInsightsClient.updateReportConfigCallable().futureCall(request);
// Do something.
ReportConfig response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateReportConfigRequest,ReportConfig> |