Class ConfigClient

java.lang.Object
com.google.cloud.logging.v2.ConfigClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated("by gapic-generator-java") public class ConfigClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service for configuring sinks used to route log entries.

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 (ConfigClient configClient = ConfigClient.create()) {
   GetBucketRequest request =
       GetBucketRequest.newBuilder()
           .setName(
               LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                   .toString())
           .build();
   LogBucket response = configClient.getBucket(request);
 }
 

Note: close() needs to be called on the ConfigClient 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

ListBuckets

Lists log buckets.

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

  • listBuckets(ListBucketsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listBuckets(BillingAccountLocationName parent)

  • listBuckets(FolderLocationName parent)

  • listBuckets(LocationName parent)

  • listBuckets(OrganizationLocationName parent)

  • listBuckets(String parent)

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

  • listBucketsPagedCallable()

  • listBucketsCallable()

GetBucket

Gets a log bucket.

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

  • getBucket(GetBucketRequest request)

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

  • getBucketCallable()

CreateBucketAsync

Creates a log bucket asynchronously that can be used to store log entries.

After a bucket has been created, the bucket's location cannot be changed.

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

  • createBucketAsyncAsync(CreateBucketRequest request)

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

  • createBucketAsyncOperationCallable()

  • createBucketAsyncCallable()

UpdateBucketAsync

Updates a log bucket asynchronously.

If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned.

After a bucket has been created, the bucket's location cannot be changed.

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

  • updateBucketAsyncAsync(UpdateBucketRequest request)

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

  • updateBucketAsyncOperationCallable()

  • updateBucketAsyncCallable()

CreateBucket

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

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

  • createBucket(CreateBucketRequest request)

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

  • createBucketCallable()

UpdateBucket

Updates a log bucket.

If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned.

After a bucket has been created, the bucket's location cannot be changed.

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

  • updateBucket(UpdateBucketRequest request)

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

  • updateBucketCallable()

DeleteBucket

Deletes a log bucket.

Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

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

  • deleteBucket(DeleteBucketRequest request)

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

  • deleteBucketCallable()

UndeleteBucket

Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

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

  • undeleteBucket(UndeleteBucketRequest request)

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

  • undeleteBucketCallable()

ListViews

Lists views on a log bucket.

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

  • listViews(ListViewsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listViews(String parent)

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

  • listViewsPagedCallable()

  • listViewsCallable()

GetView

Gets a view on a log bucket..

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

  • getView(GetViewRequest request)

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

  • getViewCallable()

CreateView

Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

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

  • createView(CreateViewRequest request)

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

  • createViewCallable()

UpdateView

Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: `filter`. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

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

  • updateView(UpdateViewRequest request)

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

  • updateViewCallable()

DeleteView

Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

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

  • deleteView(DeleteViewRequest request)

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

  • deleteViewCallable()

ListSinks

Lists sinks.

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

  • listSinks(ListSinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSinks(BillingAccountName parent)

  • listSinks(FolderName parent)

  • listSinks(OrganizationName parent)

  • listSinks(ProjectName parent)

  • listSinks(String parent)

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

  • listSinksPagedCallable()

  • listSinksCallable()

GetSink

Gets a sink.

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

  • getSink(GetSinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSink(LogSinkName sinkName)

  • getSink(String sinkName)

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

  • getSinkCallable()

CreateSink

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

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

  • createSink(CreateSinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createSink(BillingAccountName parent, LogSink sink)

  • createSink(FolderName parent, LogSink sink)

  • createSink(OrganizationName parent, LogSink sink)

  • createSink(ProjectName parent, LogSink sink)

  • createSink(String parent, LogSink sink)

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

  • createSinkCallable()

UpdateSink

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`.

The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

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

  • updateSink(UpdateSinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSink(LogSinkName sinkName, LogSink sink)

  • updateSink(String sinkName, LogSink sink)

  • updateSink(LogSinkName sinkName, LogSink sink, FieldMask updateMask)

  • updateSink(String sinkName, LogSink sink, FieldMask updateMask)

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

  • updateSinkCallable()

DeleteSink

Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.

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

  • deleteSink(DeleteSinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteSink(LogSinkName sinkName)

  • deleteSink(String sinkName)

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

  • deleteSinkCallable()

CreateLink

Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

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

  • createLinkAsync(CreateLinkRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • createLinkAsync(LogBucketName parent, Link link, String linkId)

  • createLinkAsync(String parent, Link link, String linkId)

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

  • createLinkOperationCallable()

  • createLinkCallable()

DeleteLink

Deletes a link. This will also delete the corresponding BigQuery linked dataset.

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

  • deleteLinkAsync(DeleteLinkRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • deleteLinkAsync(LinkName name)

  • deleteLinkAsync(String name)

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

  • deleteLinkOperationCallable()

  • deleteLinkCallable()

ListLinks

Lists links.

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

  • listLinks(ListLinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listLinks(LogBucketName parent)

  • listLinks(String parent)

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

  • listLinksPagedCallable()

  • listLinksCallable()

GetLink

Gets a link.

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

  • getLink(GetLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getLink(LinkName name)

  • getLink(String name)

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

  • getLinkCallable()

ListExclusions

Lists all the exclusions on the _Default sink in a parent resource.

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

  • listExclusions(ListExclusionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listExclusions(BillingAccountName parent)

  • listExclusions(FolderName parent)

  • listExclusions(OrganizationName parent)

  • listExclusions(ProjectName parent)

  • listExclusions(String parent)

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

  • listExclusionsPagedCallable()

  • listExclusionsCallable()

GetExclusion

Gets the description of an exclusion in the _Default sink.

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

  • getExclusion(GetExclusionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getExclusion(LogExclusionName name)

  • getExclusion(String name)

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

  • getExclusionCallable()

CreateExclusion

Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

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

  • createExclusion(CreateExclusionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createExclusion(BillingAccountName parent, LogExclusion exclusion)

  • createExclusion(FolderName parent, LogExclusion exclusion)

  • createExclusion(OrganizationName parent, LogExclusion exclusion)

  • createExclusion(ProjectName parent, LogExclusion exclusion)

  • createExclusion(String parent, LogExclusion exclusion)

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

  • createExclusionCallable()

UpdateExclusion

Changes one or more properties of an existing exclusion in the _Default sink.

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

  • updateExclusion(UpdateExclusionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateExclusion(LogExclusionName name, LogExclusion exclusion, FieldMask updateMask)

  • updateExclusion(String name, LogExclusion exclusion, FieldMask updateMask)

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

  • updateExclusionCallable()

DeleteExclusion

Deletes an exclusion in the _Default sink.

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

  • deleteExclusion(DeleteExclusionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteExclusion(LogExclusionName name)

  • deleteExclusion(String name)

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

  • deleteExclusionCallable()

GetCmekSettings

Gets the Logging CMEK settings for the given resource.

Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

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

  • getCmekSettings(GetCmekSettingsRequest request)

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

  • getCmekSettingsCallable()

UpdateCmekSettings

Updates the Log Router CMEK settings for the given resource.

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled.

See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

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

  • updateCmekSettings(UpdateCmekSettingsRequest request)

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

  • updateCmekSettingsCallable()

GetSettings

Gets the Log Router settings for the given resource.

Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

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

  • getSettings(GetSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSettings(SettingsName name)

  • getSettings(String name)

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

  • getSettingsCallable()

UpdateSettings

Updates the Log Router settings for the given resource.

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled. 4) `location_id` is not supported by Logging. 5) `location_id` violate OrgPolicy.

See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

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

  • updateSettings(UpdateSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSettings(Settings settings, FieldMask updateMask)

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

  • updateSettingsCallable()

CopyLogEntries

Copies a set of log entries from a log bucket to a Cloud Storage bucket.

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

  • copyLogEntriesAsync(CopyLogEntriesRequest request)

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

  • copyLogEntriesOperationCallable()

  • copyLogEntriesCallable()

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 ConfigSettings 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
 ConfigSettings configSettings =
     ConfigSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConfigClient configClient = ConfigClient.create(configSettings);
 

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
 ConfigSettings configSettings = ConfigSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConfigClient configClient = ConfigClient.create(configSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

  • Constructor Details

    • ConfigClient

      protected ConfigClient(ConfigSettings settings) throws IOException
      Constructs an instance of ConfigClient, 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.
      Throws:
      IOException
    • ConfigClient

      protected ConfigClient(ConfigServiceV2Stub stub)
  • Method Details

    • create

      public static final ConfigClient create() throws IOException
      Constructs an instance of ConfigClient with default settings.
      Throws:
      IOException
    • create

      public static final ConfigClient create(ConfigSettings settings) throws IOException
      Constructs an instance of ConfigClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException
    • create

      public static final ConfigClient create(ConfigServiceV2Stub stub)
      Constructs an instance of ConfigClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConfigSettings).
    • getSettings

      public final ConfigSettings getSettings()
    • getStub

      public ConfigServiceV2Stub getStub()
    • getOperationsClient

      public final com.google.longrunning.OperationsClient getOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
    • listBuckets

      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         BillingAccountLocationName parent =
             BillingAccountLocationName.of("[BILLING_ACCOUNT]", "[LOCATION]");
         for (LogBucket element : configClient.listBuckets(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose buckets are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

      Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listBuckets

      public final ConfigClient.ListBucketsPagedResponse listBuckets(FolderLocationName parent)
      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         FolderLocationName parent = FolderLocationName.of("[FOLDER]", "[LOCATION]");
         for (LogBucket element : configClient.listBuckets(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose buckets are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

      Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listBuckets

      public final ConfigClient.ListBucketsPagedResponse listBuckets(LocationName parent)
      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
         for (LogBucket element : configClient.listBuckets(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose buckets are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

      Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listBuckets

      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
         for (LogBucket element : configClient.listBuckets(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose buckets are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

      Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listBuckets

      public final ConfigClient.ListBucketsPagedResponse listBuckets(String parent)
      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
         for (LogBucket element : configClient.listBuckets(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose buckets are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

      Note: The locations portion of the resource must be specified, but supplying the character `-` in place of [LOCATION_ID] will return all buckets.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listBuckets

      public final ConfigClient.ListBucketsPagedResponse listBuckets(ListBucketsRequest request)
      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListBucketsRequest request =
             ListBucketsRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         for (LogBucket element : configClient.listBuckets(request).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listBucketsPagedCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListBucketsRequest,ConfigClient.ListBucketsPagedResponse> listBucketsPagedCallable()
      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListBucketsRequest request =
             ListBucketsRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         ApiFuture<LogBucket> future = configClient.listBucketsPagedCallable().futureCall(request);
         // Do something.
         for (LogBucket element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listBucketsCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListBucketsRequest,ListBucketsResponse> listBucketsCallable()
      Lists log buckets.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListBucketsRequest request =
             ListBucketsRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         while (true) {
           ListBucketsResponse response = configClient.listBucketsCallable().call(request);
           for (LogBucket element : response.getBucketsList()) {
             // doThingsWith(element);
           }
           String nextPageToken = response.getNextPageToken();
           if (!Strings.isNullOrEmpty(nextPageToken)) {
             request = request.toBuilder().setPageToken(nextPageToken).build();
           } else {
             break;
           }
         }
       }
       
    • getBucket

      public final LogBucket getBucket(GetBucketRequest request)
      Gets a log bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetBucketRequest request =
             GetBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .build();
         LogBucket response = configClient.getBucket(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getBucketCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetBucketRequest,LogBucket> getBucketCallable()
      Gets a log bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetBucketRequest request =
             GetBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .build();
         ApiFuture<LogBucket> future = configClient.getBucketCallable().futureCall(request);
         // Do something.
         LogBucket response = future.get();
       }
       
    • createBucketAsyncAsync

      public final com.google.api.gax.longrunning.OperationFuture<LogBucket,BucketMetadata> createBucketAsyncAsync(CreateBucketRequest request)
      Creates a log bucket asynchronously that can be used to store log entries.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateBucketRequest request =
             CreateBucketRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setBucketId("bucketId-1603305307")
                 .setBucket(LogBucket.newBuilder().build())
                 .build();
         LogBucket response = configClient.createBucketAsyncAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createBucketAsyncOperationCallable

      public final com.google.api.gax.rpc.OperationCallable<CreateBucketRequest,LogBucket,BucketMetadata> createBucketAsyncOperationCallable()
      Creates a log bucket asynchronously that can be used to store log entries.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateBucketRequest request =
             CreateBucketRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setBucketId("bucketId-1603305307")
                 .setBucket(LogBucket.newBuilder().build())
                 .build();
         OperationFuture<LogBucket, BucketMetadata> future =
             configClient.createBucketAsyncOperationCallable().futureCall(request);
         // Do something.
         LogBucket response = future.get();
       }
       
    • createBucketAsyncCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateBucketRequest,com.google.longrunning.Operation> createBucketAsyncCallable()
      Creates a log bucket asynchronously that can be used to store log entries.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateBucketRequest request =
             CreateBucketRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setBucketId("bucketId-1603305307")
                 .setBucket(LogBucket.newBuilder().build())
                 .build();
         ApiFuture<Operation> future = configClient.createBucketAsyncCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • updateBucketAsyncAsync

      public final com.google.api.gax.longrunning.OperationFuture<LogBucket,BucketMetadata> updateBucketAsyncAsync(UpdateBucketRequest request)
      Updates a log bucket asynchronously.

      If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateBucketRequest request =
             UpdateBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setBucket(LogBucket.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         LogBucket response = configClient.updateBucketAsyncAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateBucketAsyncOperationCallable

      public final com.google.api.gax.rpc.OperationCallable<UpdateBucketRequest,LogBucket,BucketMetadata> updateBucketAsyncOperationCallable()
      Updates a log bucket asynchronously.

      If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateBucketRequest request =
             UpdateBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setBucket(LogBucket.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         OperationFuture<LogBucket, BucketMetadata> future =
             configClient.updateBucketAsyncOperationCallable().futureCall(request);
         // Do something.
         LogBucket response = future.get();
       }
       
    • updateBucketAsyncCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateBucketRequest,com.google.longrunning.Operation> updateBucketAsyncCallable()
      Updates a log bucket asynchronously.

      If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateBucketRequest request =
             UpdateBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setBucket(LogBucket.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<Operation> future = configClient.updateBucketAsyncCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • createBucket

      public final LogBucket createBucket(CreateBucketRequest request)
      Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateBucketRequest request =
             CreateBucketRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setBucketId("bucketId-1603305307")
                 .setBucket(LogBucket.newBuilder().build())
                 .build();
         LogBucket response = configClient.createBucket(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createBucketCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateBucketRequest,LogBucket> createBucketCallable()
      Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateBucketRequest request =
             CreateBucketRequest.newBuilder()
                 .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
                 .setBucketId("bucketId-1603305307")
                 .setBucket(LogBucket.newBuilder().build())
                 .build();
         ApiFuture<LogBucket> future = configClient.createBucketCallable().futureCall(request);
         // Do something.
         LogBucket response = future.get();
       }
       
    • updateBucket

      public final LogBucket updateBucket(UpdateBucketRequest request)
      Updates a log bucket.

      If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateBucketRequest request =
             UpdateBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setBucket(LogBucket.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         LogBucket response = configClient.updateBucket(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateBucketCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateBucketRequest,LogBucket> updateBucketCallable()
      Updates a log bucket.

      If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned.

      After a bucket has been created, the bucket's location cannot be changed.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateBucketRequest request =
             UpdateBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setBucket(LogBucket.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<LogBucket> future = configClient.updateBucketCallable().futureCall(request);
         // Do something.
         LogBucket response = future.get();
       }
       
    • deleteBucket

      public final void deleteBucket(DeleteBucketRequest request)
      Deletes a log bucket.

      Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteBucketRequest request =
             DeleteBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .build();
         configClient.deleteBucket(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteBucketCallable

      public final com.google.api.gax.rpc.UnaryCallable<DeleteBucketRequest,com.google.protobuf.Empty> deleteBucketCallable()
      Deletes a log bucket.

      Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteBucketRequest request =
             DeleteBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .build();
         ApiFuture<Empty> future = configClient.deleteBucketCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • undeleteBucket

      public final void undeleteBucket(UndeleteBucketRequest request)
      Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UndeleteBucketRequest request =
             UndeleteBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .build();
         configClient.undeleteBucket(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • undeleteBucketCallable

      public final com.google.api.gax.rpc.UnaryCallable<UndeleteBucketRequest,com.google.protobuf.Empty> undeleteBucketCallable()
      Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UndeleteBucketRequest request =
             UndeleteBucketRequest.newBuilder()
                 .setName(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .build();
         ApiFuture<Empty> future = configClient.undeleteBucketCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • listViews

      public final ConfigClient.ListViewsPagedResponse listViews(String parent)
      Lists views on a log bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent = "parent-995424086";
         for (LogView element : configClient.listViews(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The bucket whose views are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listViews

      public final ConfigClient.ListViewsPagedResponse listViews(ListViewsRequest request)
      Lists views on a log bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListViewsRequest request =
             ListViewsRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         for (LogView element : configClient.listViews(request).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listViewsPagedCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListViewsRequest,ConfigClient.ListViewsPagedResponse> listViewsPagedCallable()
      Lists views on a log bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListViewsRequest request =
             ListViewsRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         ApiFuture<LogView> future = configClient.listViewsPagedCallable().futureCall(request);
         // Do something.
         for (LogView element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listViewsCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListViewsRequest,ListViewsResponse> listViewsCallable()
      Lists views on a log bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListViewsRequest request =
             ListViewsRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         while (true) {
           ListViewsResponse response = configClient.listViewsCallable().call(request);
           for (LogView element : response.getViewsList()) {
             // doThingsWith(element);
           }
           String nextPageToken = response.getNextPageToken();
           if (!Strings.isNullOrEmpty(nextPageToken)) {
             request = request.toBuilder().setPageToken(nextPageToken).build();
           } else {
             break;
           }
         }
       }
       
    • getView

      public final LogView getView(GetViewRequest request)
      Gets a view on a log bucket..

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetViewRequest request =
             GetViewRequest.newBuilder()
                 .setName(
                     LogViewName.ofProjectLocationBucketViewName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[VIEW]")
                         .toString())
                 .build();
         LogView response = configClient.getView(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getViewCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetViewRequest,LogView> getViewCallable()
      Gets a view on a log bucket..

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetViewRequest request =
             GetViewRequest.newBuilder()
                 .setName(
                     LogViewName.ofProjectLocationBucketViewName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[VIEW]")
                         .toString())
                 .build();
         ApiFuture<LogView> future = configClient.getViewCallable().futureCall(request);
         // Do something.
         LogView response = future.get();
       }
       
    • createView

      public final LogView createView(CreateViewRequest request)
      Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateViewRequest request =
             CreateViewRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setViewId("viewId-816632160")
                 .setView(LogView.newBuilder().build())
                 .build();
         LogView response = configClient.createView(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createViewCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateViewRequest,LogView> createViewCallable()
      Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateViewRequest request =
             CreateViewRequest.newBuilder()
                 .setParent("parent-995424086")
                 .setViewId("viewId-816632160")
                 .setView(LogView.newBuilder().build())
                 .build();
         ApiFuture<LogView> future = configClient.createViewCallable().futureCall(request);
         // Do something.
         LogView response = future.get();
       }
       
    • updateView

      public final LogView updateView(UpdateViewRequest request)
      Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: `filter`. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateViewRequest request =
             UpdateViewRequest.newBuilder()
                 .setName("name3373707")
                 .setView(LogView.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         LogView response = configClient.updateView(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateViewCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateViewRequest,LogView> updateViewCallable()
      Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: `filter`. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateViewRequest request =
             UpdateViewRequest.newBuilder()
                 .setName("name3373707")
                 .setView(LogView.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<LogView> future = configClient.updateViewCallable().futureCall(request);
         // Do something.
         LogView response = future.get();
       }
       
    • deleteView

      public final void deleteView(DeleteViewRequest request)
      Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteViewRequest request =
             DeleteViewRequest.newBuilder()
                 .setName(
                     LogViewName.ofProjectLocationBucketViewName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[VIEW]")
                         .toString())
                 .build();
         configClient.deleteView(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteViewCallable

      public final com.google.api.gax.rpc.UnaryCallable<DeleteViewRequest,com.google.protobuf.Empty> deleteViewCallable()
      Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteViewRequest request =
             DeleteViewRequest.newBuilder()
                 .setName(
                     LogViewName.ofProjectLocationBucketViewName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[VIEW]")
                         .toString())
                 .build();
         ApiFuture<Empty> future = configClient.deleteViewCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • listSinks

      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
         for (LogSink element : configClient.listSinks(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose sinks are to be listed:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listSinks

      public final ConfigClient.ListSinksPagedResponse listSinks(FolderName parent)
      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         FolderName parent = FolderName.of("[FOLDER]");
         for (LogSink element : configClient.listSinks(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose sinks are to be listed:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listSinks

      public final ConfigClient.ListSinksPagedResponse listSinks(OrganizationName parent)
      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
         for (LogSink element : configClient.listSinks(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose sinks are to be listed:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listSinks

      public final ConfigClient.ListSinksPagedResponse listSinks(ProjectName parent)
      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ProjectName parent = ProjectName.of("[PROJECT]");
         for (LogSink element : configClient.listSinks(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose sinks are to be listed:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listSinks

      public final ConfigClient.ListSinksPagedResponse listSinks(String parent)
      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent = ProjectName.of("[PROJECT]").toString();
         for (LogSink element : configClient.listSinks(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose sinks are to be listed:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listSinks

      public final ConfigClient.ListSinksPagedResponse listSinks(ListSinksRequest request)
      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListSinksRequest request =
             ListSinksRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         for (LogSink element : configClient.listSinks(request).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listSinksPagedCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListSinksRequest,ConfigClient.ListSinksPagedResponse> listSinksPagedCallable()
      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListSinksRequest request =
             ListSinksRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         ApiFuture<LogSink> future = configClient.listSinksPagedCallable().futureCall(request);
         // Do something.
         for (LogSink element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listSinksCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListSinksRequest,ListSinksResponse> listSinksCallable()
      Lists sinks.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListSinksRequest request =
             ListSinksRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         while (true) {
           ListSinksResponse response = configClient.listSinksCallable().call(request);
           for (LogSink element : response.getSinksList()) {
             // doThingsWith(element);
           }
           String nextPageToken = response.getNextPageToken();
           if (!Strings.isNullOrEmpty(nextPageToken)) {
             request = request.toBuilder().setPageToken(nextPageToken).build();
           } else {
             break;
           }
         }
       }
       
    • getSink

      public final LogSink getSink(LogSinkName sinkName)
      Gets a sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogSinkName sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]");
         LogSink response = configClient.getSink(sinkName);
       }
       
      Parameters:
      sinkName - Required. The resource name of the sink:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getSink

      public final LogSink getSink(String sinkName)
      Gets a sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString();
         LogSink response = configClient.getSink(sinkName);
       }
       
      Parameters:
      sinkName - Required. The resource name of the sink:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getSink

      public final LogSink getSink(GetSinkRequest request)
      Gets a sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetSinkRequest request =
             GetSinkRequest.newBuilder()
                 .setSinkName(LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString())
                 .build();
         LogSink response = configClient.getSink(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getSinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetSinkRequest,LogSink> getSinkCallable()
      Gets a sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetSinkRequest request =
             GetSinkRequest.newBuilder()
                 .setSinkName(LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString())
                 .build();
         ApiFuture<LogSink> future = configClient.getSinkCallable().futureCall(request);
         // Do something.
         LogSink response = future.get();
       }
       
    • createSink

      public final LogSink createSink(BillingAccountName parent, LogSink sink)
      Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
         LogSink sink = LogSink.newBuilder().build();
         LogSink response = configClient.createSink(parent, sink);
       }
       
      Parameters:
      parent - Required. The resource in which to create the sink:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-project"` `"organizations/123456789"`

      sink - Required. The new sink, whose `name` parameter is a sink identifier that is not already in use.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createSink

      public final LogSink createSink(FolderName parent, LogSink sink)
      Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         FolderName parent = FolderName.of("[FOLDER]");
         LogSink sink = LogSink.newBuilder().build();
         LogSink response = configClient.createSink(parent, sink);
       }
       
      Parameters:
      parent - Required. The resource in which to create the sink:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-project"` `"organizations/123456789"`

      sink - Required. The new sink, whose `name` parameter is a sink identifier that is not already in use.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createSink

      public final LogSink createSink(OrganizationName parent, LogSink sink)
      Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
         LogSink sink = LogSink.newBuilder().build();
         LogSink response = configClient.createSink(parent, sink);
       }
       
      Parameters:
      parent - Required. The resource in which to create the sink:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-project"` `"organizations/123456789"`

      sink - Required. The new sink, whose `name` parameter is a sink identifier that is not already in use.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createSink

      public final LogSink createSink(ProjectName parent, LogSink sink)
      Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ProjectName parent = ProjectName.of("[PROJECT]");
         LogSink sink = LogSink.newBuilder().build();
         LogSink response = configClient.createSink(parent, sink);
       }
       
      Parameters:
      parent - Required. The resource in which to create the sink:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-project"` `"organizations/123456789"`

      sink - Required. The new sink, whose `name` parameter is a sink identifier that is not already in use.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createSink

      public final LogSink createSink(String parent, LogSink sink)
      Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent = ProjectName.of("[PROJECT]").toString();
         LogSink sink = LogSink.newBuilder().build();
         LogSink response = configClient.createSink(parent, sink);
       }
       
      Parameters:
      parent - Required. The resource in which to create the sink:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-project"` `"organizations/123456789"`

      sink - Required. The new sink, whose `name` parameter is a sink identifier that is not already in use.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createSink

      public final LogSink createSink(CreateSinkRequest request)
      Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateSinkRequest request =
             CreateSinkRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setSink(LogSink.newBuilder().build())
                 .setUniqueWriterIdentity(true)
                 .build();
         LogSink response = configClient.createSink(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createSinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateSinkRequest,LogSink> createSinkCallable()
      Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateSinkRequest request =
             CreateSinkRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setSink(LogSink.newBuilder().build())
                 .setUniqueWriterIdentity(true)
                 .build();
         ApiFuture<LogSink> future = configClient.createSinkCallable().futureCall(request);
         // Do something.
         LogSink response = future.get();
       }
       
    • updateSink

      public final LogSink updateSink(LogSinkName sinkName, LogSink sink)
      Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`.

      The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogSinkName sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]");
         LogSink sink = LogSink.newBuilder().build();
         LogSink response = configClient.updateSink(sinkName, sink);
       }
       
      Parameters:
      sinkName - Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      sink - Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateSink

      public final LogSink updateSink(String sinkName, LogSink sink)
      Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`.

      The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString();
         LogSink sink = LogSink.newBuilder().build();
         LogSink response = configClient.updateSink(sinkName, sink);
       }
       
      Parameters:
      sinkName - Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      sink - Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateSink

      public final LogSink updateSink(LogSinkName sinkName, LogSink sink, com.google.protobuf.FieldMask updateMask)
      Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`.

      The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogSinkName sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]");
         LogSink sink = LogSink.newBuilder().build();
         FieldMask updateMask = FieldMask.newBuilder().build();
         LogSink response = configClient.updateSink(sinkName, sink, updateMask);
       }
       
      Parameters:
      sinkName - Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      sink - Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.
      updateMask - Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated.

      An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes:

      `destination,filter,includeChildren`

      At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error.

      For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask

      For example: `updateMask=filter`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateSink

      public final LogSink updateSink(String sinkName, LogSink sink, com.google.protobuf.FieldMask updateMask)
      Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`.

      The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString();
         LogSink sink = LogSink.newBuilder().build();
         FieldMask updateMask = FieldMask.newBuilder().build();
         LogSink response = configClient.updateSink(sinkName, sink, updateMask);
       }
       
      Parameters:
      sinkName - Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      sink - Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.
      updateMask - Optional. Field mask that specifies the fields in `sink` that need an update. A sink field will be overwritten if, and only if, it is in the update mask. `name` and output only fields cannot be updated.

      An empty `updateMask` is temporarily treated as using the following mask for backwards compatibility purposes:

      `destination,filter,includeChildren`

      At some point in the future, behavior will be removed and specifying an empty `updateMask` will be an error.

      For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask

      For example: `updateMask=filter`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateSink

      public final LogSink updateSink(UpdateSinkRequest request)
      Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`.

      The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateSinkRequest request =
             UpdateSinkRequest.newBuilder()
                 .setSinkName(LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString())
                 .setSink(LogSink.newBuilder().build())
                 .setUniqueWriterIdentity(true)
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         LogSink response = configClient.updateSink(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateSinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateSinkRequest,LogSink> updateSinkCallable()
      Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`.

      The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateSinkRequest request =
             UpdateSinkRequest.newBuilder()
                 .setSinkName(LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString())
                 .setSink(LogSink.newBuilder().build())
                 .setUniqueWriterIdentity(true)
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<LogSink> future = configClient.updateSinkCallable().futureCall(request);
         // Do something.
         LogSink response = future.get();
       }
       
    • deleteSink

      public final void deleteSink(LogSinkName sinkName)
      Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogSinkName sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]");
         configClient.deleteSink(sinkName);
       }
       
      Parameters:
      sinkName - Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteSink

      public final void deleteSink(String sinkName)
      Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String sinkName = LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString();
         configClient.deleteSink(sinkName);
       }
       
      Parameters:
      sinkName - Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:

      "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"

      For example:

      `"projects/my-project/sinks/my-sink"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteSink

      public final void deleteSink(DeleteSinkRequest request)
      Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteSinkRequest request =
             DeleteSinkRequest.newBuilder()
                 .setSinkName(LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString())
                 .build();
         configClient.deleteSink(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteSinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<DeleteSinkRequest,com.google.protobuf.Empty> deleteSinkCallable()
      Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteSinkRequest request =
             DeleteSinkRequest.newBuilder()
                 .setSinkName(LogSinkName.ofProjectSinkName("[PROJECT]", "[SINK]").toString())
                 .build();
         ApiFuture<Empty> future = configClient.deleteSinkCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • createLinkAsync

      public final com.google.api.gax.longrunning.OperationFuture<Link,LinkMetadata> createLinkAsync(LogBucketName parent, Link link, String linkId)
      Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogBucketName parent =
             LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]");
         Link link = Link.newBuilder().build();
         String linkId = "linkId-1102667083";
         Link response = configClient.createLinkAsync(parent, link, linkId).get();
       }
       
      Parameters:
      parent - Required. The full resource name of the bucket to create a link for.

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

      link - Required. The new link.
      linkId - Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createLinkAsync

      public final com.google.api.gax.longrunning.OperationFuture<Link,LinkMetadata> createLinkAsync(String parent, Link link, String linkId)
      Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent =
             LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                 .toString();
         Link link = Link.newBuilder().build();
         String linkId = "linkId-1102667083";
         Link response = configClient.createLinkAsync(parent, link, linkId).get();
       }
       
      Parameters:
      parent - Required. The full resource name of the bucket to create a link for.

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

      link - Required. The new link.
      linkId - Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createLinkAsync

      public final com.google.api.gax.longrunning.OperationFuture<Link,LinkMetadata> createLinkAsync(CreateLinkRequest request)
      Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateLinkRequest request =
             CreateLinkRequest.newBuilder()
                 .setParent(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setLink(Link.newBuilder().build())
                 .setLinkId("linkId-1102667083")
                 .build();
         Link response = configClient.createLinkAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createLinkOperationCallable

      public final com.google.api.gax.rpc.OperationCallable<CreateLinkRequest,Link,LinkMetadata> createLinkOperationCallable()
      Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateLinkRequest request =
             CreateLinkRequest.newBuilder()
                 .setParent(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setLink(Link.newBuilder().build())
                 .setLinkId("linkId-1102667083")
                 .build();
         OperationFuture<Link, LinkMetadata> future =
             configClient.createLinkOperationCallable().futureCall(request);
         // Do something.
         Link response = future.get();
       }
       
    • createLinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateLinkRequest,com.google.longrunning.Operation> createLinkCallable()
      Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateLinkRequest request =
             CreateLinkRequest.newBuilder()
                 .setParent(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setLink(Link.newBuilder().build())
                 .setLinkId("linkId-1102667083")
                 .build();
         ApiFuture<Operation> future = configClient.createLinkCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • deleteLinkAsync

      public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,LinkMetadata> deleteLinkAsync(LinkName name)
      Deletes a link. This will also delete the corresponding BigQuery linked dataset.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LinkName name =
             LinkName.ofProjectLocationBucketLinkName("[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]");
         configClient.deleteLinkAsync(name).get();
       }
       
      Parameters:
      name - Required. The full resource name of the link to delete.

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteLinkAsync

      public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,LinkMetadata> deleteLinkAsync(String name)
      Deletes a link. This will also delete the corresponding BigQuery linked dataset.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String name =
             LinkName.ofProjectLocationBucketLinkName("[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]")
                 .toString();
         configClient.deleteLinkAsync(name).get();
       }
       
      Parameters:
      name - Required. The full resource name of the link to delete.

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteLinkAsync

      public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,LinkMetadata> deleteLinkAsync(DeleteLinkRequest request)
      Deletes a link. This will also delete the corresponding BigQuery linked dataset.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteLinkRequest request =
             DeleteLinkRequest.newBuilder()
                 .setName(
                     LinkName.ofProjectLocationBucketLinkName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]")
                         .toString())
                 .build();
         configClient.deleteLinkAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteLinkOperationCallable

      public final com.google.api.gax.rpc.OperationCallable<DeleteLinkRequest,com.google.protobuf.Empty,LinkMetadata> deleteLinkOperationCallable()
      Deletes a link. This will also delete the corresponding BigQuery linked dataset.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteLinkRequest request =
             DeleteLinkRequest.newBuilder()
                 .setName(
                     LinkName.ofProjectLocationBucketLinkName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]")
                         .toString())
                 .build();
         OperationFuture<Empty, LinkMetadata> future =
             configClient.deleteLinkOperationCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • deleteLinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<DeleteLinkRequest,com.google.longrunning.Operation> deleteLinkCallable()
      Deletes a link. This will also delete the corresponding BigQuery linked dataset.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteLinkRequest request =
             DeleteLinkRequest.newBuilder()
                 .setName(
                     LinkName.ofProjectLocationBucketLinkName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]")
                         .toString())
                 .build();
         ApiFuture<Operation> future = configClient.deleteLinkCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • listLinks

      public final ConfigClient.ListLinksPagedResponse listLinks(LogBucketName parent)
      Lists links.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogBucketName parent =
             LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]");
         for (Link element : configClient.listLinks(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose links are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listLinks

      public final ConfigClient.ListLinksPagedResponse listLinks(String parent)
      Lists links.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent =
             LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                 .toString();
         for (Link element : configClient.listLinks(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose links are to be listed:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listLinks

      public final ConfigClient.ListLinksPagedResponse listLinks(ListLinksRequest request)
      Lists links.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListLinksRequest request =
             ListLinksRequest.newBuilder()
                 .setParent(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         for (Link element : configClient.listLinks(request).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listLinksPagedCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListLinksRequest,ConfigClient.ListLinksPagedResponse> listLinksPagedCallable()
      Lists links.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListLinksRequest request =
             ListLinksRequest.newBuilder()
                 .setParent(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         ApiFuture<Link> future = configClient.listLinksPagedCallable().futureCall(request);
         // Do something.
         for (Link element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listLinksCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListLinksRequest,ListLinksResponse> listLinksCallable()
      Lists links.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListLinksRequest request =
             ListLinksRequest.newBuilder()
                 .setParent(
                     LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                         .toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         while (true) {
           ListLinksResponse response = configClient.listLinksCallable().call(request);
           for (Link element : response.getLinksList()) {
             // doThingsWith(element);
           }
           String nextPageToken = response.getNextPageToken();
           if (!Strings.isNullOrEmpty(nextPageToken)) {
             request = request.toBuilder().setPageToken(nextPageToken).build();
           } else {
             break;
           }
         }
       }
       
    • getLink

      public final Link getLink(LinkName name)
      Gets a link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LinkName name =
             LinkName.ofProjectLocationBucketLinkName("[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]");
         Link response = configClient.getLink(name);
       }
       
      Parameters:
      name - Required. The resource name of the link:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getLink

      public final Link getLink(String name)
      Gets a link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String name =
             LinkName.ofProjectLocationBucketLinkName("[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]")
                 .toString();
         Link response = configClient.getLink(name);
       }
       
      Parameters:
      name - Required. The resource name of the link:

      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getLink

      public final Link getLink(GetLinkRequest request)
      Gets a link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetLinkRequest request =
             GetLinkRequest.newBuilder()
                 .setName(
                     LinkName.ofProjectLocationBucketLinkName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]")
                         .toString())
                 .build();
         Link response = configClient.getLink(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getLinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetLinkRequest,Link> getLinkCallable()
      Gets a link.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetLinkRequest request =
             GetLinkRequest.newBuilder()
                 .setName(
                     LinkName.ofProjectLocationBucketLinkName(
                             "[PROJECT]", "[LOCATION]", "[BUCKET]", "[LINK]")
                         .toString())
                 .build();
         ApiFuture<Link> future = configClient.getLinkCallable().futureCall(request);
         // Do something.
         Link response = future.get();
       }
       
    • listExclusions

      public final ConfigClient.ListExclusionsPagedResponse listExclusions(BillingAccountName parent)
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
         for (LogExclusion element : configClient.listExclusions(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose exclusions are to be listed.

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listExclusions

      public final ConfigClient.ListExclusionsPagedResponse listExclusions(FolderName parent)
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         FolderName parent = FolderName.of("[FOLDER]");
         for (LogExclusion element : configClient.listExclusions(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose exclusions are to be listed.

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listExclusions

      public final ConfigClient.ListExclusionsPagedResponse listExclusions(OrganizationName parent)
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
         for (LogExclusion element : configClient.listExclusions(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose exclusions are to be listed.

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listExclusions

      public final ConfigClient.ListExclusionsPagedResponse listExclusions(ProjectName parent)
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ProjectName parent = ProjectName.of("[PROJECT]");
         for (LogExclusion element : configClient.listExclusions(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose exclusions are to be listed.

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listExclusions

      public final ConfigClient.ListExclusionsPagedResponse listExclusions(String parent)
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent = ProjectName.of("[PROJECT]").toString();
         for (LogExclusion element : configClient.listExclusions(parent).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      parent - Required. The parent resource whose exclusions are to be listed.

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listExclusions

      public final ConfigClient.ListExclusionsPagedResponse listExclusions(ListExclusionsRequest request)
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListExclusionsRequest request =
             ListExclusionsRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         for (LogExclusion element : configClient.listExclusions(request).iterateAll()) {
           // doThingsWith(element);
         }
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • listExclusionsPagedCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListExclusionsRequest,ConfigClient.ListExclusionsPagedResponse> listExclusionsPagedCallable()
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListExclusionsRequest request =
             ListExclusionsRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         ApiFuture<LogExclusion> future =
             configClient.listExclusionsPagedCallable().futureCall(request);
         // Do something.
         for (LogExclusion element : future.get().iterateAll()) {
           // doThingsWith(element);
         }
       }
       
    • listExclusionsCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListExclusionsRequest,ListExclusionsResponse> listExclusionsCallable()
      Lists all the exclusions on the _Default sink in a parent resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ListExclusionsRequest request =
             ListExclusionsRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setPageToken("pageToken873572522")
                 .setPageSize(883849137)
                 .build();
         while (true) {
           ListExclusionsResponse response = configClient.listExclusionsCallable().call(request);
           for (LogExclusion element : response.getExclusionsList()) {
             // doThingsWith(element);
           }
           String nextPageToken = response.getNextPageToken();
           if (!Strings.isNullOrEmpty(nextPageToken)) {
             request = request.toBuilder().setPageToken(nextPageToken).build();
           } else {
             break;
           }
         }
       }
       
    • getExclusion

      public final LogExclusion getExclusion(LogExclusionName name)
      Gets the description of an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogExclusionName name = LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]");
         LogExclusion response = configClient.getExclusion(name);
       }
       
      Parameters:
      name - Required. The resource name of an existing exclusion:

      "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

      For example:

      `"projects/my-project/exclusions/my-exclusion"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getExclusion

      public final LogExclusion getExclusion(String name)
      Gets the description of an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String name = LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString();
         LogExclusion response = configClient.getExclusion(name);
       }
       
      Parameters:
      name - Required. The resource name of an existing exclusion:

      "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

      For example:

      `"projects/my-project/exclusions/my-exclusion"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getExclusion

      public final LogExclusion getExclusion(GetExclusionRequest request)
      Gets the description of an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetExclusionRequest request =
             GetExclusionRequest.newBuilder()
                 .setName(
                     LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString())
                 .build();
         LogExclusion response = configClient.getExclusion(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getExclusionCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetExclusionRequest,LogExclusion> getExclusionCallable()
      Gets the description of an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetExclusionRequest request =
             GetExclusionRequest.newBuilder()
                 .setName(
                     LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString())
                 .build();
         ApiFuture<LogExclusion> future = configClient.getExclusionCallable().futureCall(request);
         // Do something.
         LogExclusion response = future.get();
       }
       
    • createExclusion

      public final LogExclusion createExclusion(BillingAccountName parent, LogExclusion exclusion)
      Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
         LogExclusion exclusion = LogExclusion.newBuilder().build();
         LogExclusion response = configClient.createExclusion(parent, exclusion);
       }
       
      Parameters:
      parent - Required. The parent resource in which to create the exclusion:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-logging-project"` `"organizations/123456789"`

      exclusion - Required. The new exclusion, whose `name` parameter is an exclusion name that is not already used in the parent resource.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createExclusion

      public final LogExclusion createExclusion(FolderName parent, LogExclusion exclusion)
      Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         FolderName parent = FolderName.of("[FOLDER]");
         LogExclusion exclusion = LogExclusion.newBuilder().build();
         LogExclusion response = configClient.createExclusion(parent, exclusion);
       }
       
      Parameters:
      parent - Required. The parent resource in which to create the exclusion:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-logging-project"` `"organizations/123456789"`

      exclusion - Required. The new exclusion, whose `name` parameter is an exclusion name that is not already used in the parent resource.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createExclusion

      public final LogExclusion createExclusion(OrganizationName parent, LogExclusion exclusion)
      Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
         LogExclusion exclusion = LogExclusion.newBuilder().build();
         LogExclusion response = configClient.createExclusion(parent, exclusion);
       }
       
      Parameters:
      parent - Required. The parent resource in which to create the exclusion:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-logging-project"` `"organizations/123456789"`

      exclusion - Required. The new exclusion, whose `name` parameter is an exclusion name that is not already used in the parent resource.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createExclusion

      public final LogExclusion createExclusion(ProjectName parent, LogExclusion exclusion)
      Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         ProjectName parent = ProjectName.of("[PROJECT]");
         LogExclusion exclusion = LogExclusion.newBuilder().build();
         LogExclusion response = configClient.createExclusion(parent, exclusion);
       }
       
      Parameters:
      parent - Required. The parent resource in which to create the exclusion:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-logging-project"` `"organizations/123456789"`

      exclusion - Required. The new exclusion, whose `name` parameter is an exclusion name that is not already used in the parent resource.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createExclusion

      public final LogExclusion createExclusion(String parent, LogExclusion exclusion)
      Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String parent = ProjectName.of("[PROJECT]").toString();
         LogExclusion exclusion = LogExclusion.newBuilder().build();
         LogExclusion response = configClient.createExclusion(parent, exclusion);
       }
       
      Parameters:
      parent - Required. The parent resource in which to create the exclusion:

      "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

      For examples:

      `"projects/my-logging-project"` `"organizations/123456789"`

      exclusion - Required. The new exclusion, whose `name` parameter is an exclusion name that is not already used in the parent resource.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createExclusion

      public final LogExclusion createExclusion(CreateExclusionRequest request)
      Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateExclusionRequest request =
             CreateExclusionRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setExclusion(LogExclusion.newBuilder().build())
                 .build();
         LogExclusion response = configClient.createExclusion(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • createExclusionCallable

      public final com.google.api.gax.rpc.UnaryCallable<CreateExclusionRequest,LogExclusion> createExclusionCallable()
      Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CreateExclusionRequest request =
             CreateExclusionRequest.newBuilder()
                 .setParent(ProjectName.of("[PROJECT]").toString())
                 .setExclusion(LogExclusion.newBuilder().build())
                 .build();
         ApiFuture<LogExclusion> future = configClient.createExclusionCallable().futureCall(request);
         // Do something.
         LogExclusion response = future.get();
       }
       
    • updateExclusion

      public final LogExclusion updateExclusion(LogExclusionName name, LogExclusion exclusion, com.google.protobuf.FieldMask updateMask)
      Changes one or more properties of an existing exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogExclusionName name = LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]");
         LogExclusion exclusion = LogExclusion.newBuilder().build();
         FieldMask updateMask = FieldMask.newBuilder().build();
         LogExclusion response = configClient.updateExclusion(name, exclusion, updateMask);
       }
       
      Parameters:
      name - Required. The resource name of the exclusion to update:

      "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

      For example:

      `"projects/my-project/exclusions/my-exclusion"`

      exclusion - Required. New values for the existing exclusion. Only the fields specified in `update_mask` are relevant.
      updateMask - Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the [LogExclusion][google.logging.v2.LogExclusion] included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request.

      For example, to change the filter and description of an exclusion, specify an `update_mask` of `"filter,description"`.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateExclusion

      public final LogExclusion updateExclusion(String name, LogExclusion exclusion, com.google.protobuf.FieldMask updateMask)
      Changes one or more properties of an existing exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String name = LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString();
         LogExclusion exclusion = LogExclusion.newBuilder().build();
         FieldMask updateMask = FieldMask.newBuilder().build();
         LogExclusion response = configClient.updateExclusion(name, exclusion, updateMask);
       }
       
      Parameters:
      name - Required. The resource name of the exclusion to update:

      "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

      For example:

      `"projects/my-project/exclusions/my-exclusion"`

      exclusion - Required. New values for the existing exclusion. Only the fields specified in `update_mask` are relevant.
      updateMask - Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the [LogExclusion][google.logging.v2.LogExclusion] included in this request. Fields not mentioned in `update_mask` are not changed and are ignored in the request.

      For example, to change the filter and description of an exclusion, specify an `update_mask` of `"filter,description"`.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateExclusion

      public final LogExclusion updateExclusion(UpdateExclusionRequest request)
      Changes one or more properties of an existing exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateExclusionRequest request =
             UpdateExclusionRequest.newBuilder()
                 .setName(
                     LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString())
                 .setExclusion(LogExclusion.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         LogExclusion response = configClient.updateExclusion(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateExclusionCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateExclusionRequest,LogExclusion> updateExclusionCallable()
      Changes one or more properties of an existing exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateExclusionRequest request =
             UpdateExclusionRequest.newBuilder()
                 .setName(
                     LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString())
                 .setExclusion(LogExclusion.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<LogExclusion> future = configClient.updateExclusionCallable().futureCall(request);
         // Do something.
         LogExclusion response = future.get();
       }
       
    • deleteExclusion

      public final void deleteExclusion(LogExclusionName name)
      Deletes an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         LogExclusionName name = LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]");
         configClient.deleteExclusion(name);
       }
       
      Parameters:
      name - Required. The resource name of an existing exclusion to delete:

      "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

      For example:

      `"projects/my-project/exclusions/my-exclusion"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteExclusion

      public final void deleteExclusion(String name)
      Deletes an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String name = LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString();
         configClient.deleteExclusion(name);
       }
       
      Parameters:
      name - Required. The resource name of an existing exclusion to delete:

      "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"

      For example:

      `"projects/my-project/exclusions/my-exclusion"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteExclusion

      public final void deleteExclusion(DeleteExclusionRequest request)
      Deletes an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteExclusionRequest request =
             DeleteExclusionRequest.newBuilder()
                 .setName(
                     LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString())
                 .build();
         configClient.deleteExclusion(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • deleteExclusionCallable

      public final com.google.api.gax.rpc.UnaryCallable<DeleteExclusionRequest,com.google.protobuf.Empty> deleteExclusionCallable()
      Deletes an exclusion in the _Default sink.

      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 (ConfigClient configClient = ConfigClient.create()) {
         DeleteExclusionRequest request =
             DeleteExclusionRequest.newBuilder()
                 .setName(
                     LogExclusionName.ofProjectExclusionName("[PROJECT]", "[EXCLUSION]").toString())
                 .build();
         ApiFuture<Empty> future = configClient.deleteExclusionCallable().futureCall(request);
         // Do something.
         future.get();
       }
       
    • getCmekSettings

      public final CmekSettings getCmekSettings(GetCmekSettingsRequest request)
      Gets the Logging CMEK settings for the given resource.

      Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetCmekSettingsRequest request =
             GetCmekSettingsRequest.newBuilder()
                 .setName(CmekSettingsName.ofProjectName("[PROJECT]").toString())
                 .build();
         CmekSettings response = configClient.getCmekSettings(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getCmekSettingsCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetCmekSettingsRequest,CmekSettings> getCmekSettingsCallable()
      Gets the Logging CMEK settings for the given resource.

      Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetCmekSettingsRequest request =
             GetCmekSettingsRequest.newBuilder()
                 .setName(CmekSettingsName.ofProjectName("[PROJECT]").toString())
                 .build();
         ApiFuture<CmekSettings> future = configClient.getCmekSettingsCallable().futureCall(request);
         // Do something.
         CmekSettings response = future.get();
       }
       
    • updateCmekSettings

      public final CmekSettings updateCmekSettings(UpdateCmekSettingsRequest request)
      Updates the Log Router CMEK settings for the given resource.

      Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

      [UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateCmekSettingsRequest request =
             UpdateCmekSettingsRequest.newBuilder()
                 .setName("name3373707")
                 .setCmekSettings(CmekSettings.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         CmekSettings response = configClient.updateCmekSettings(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateCmekSettingsCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateCmekSettingsRequest,CmekSettings> updateCmekSettingsCallable()
      Updates the Log Router CMEK settings for the given resource.

      Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

      [UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateCmekSettingsRequest request =
             UpdateCmekSettingsRequest.newBuilder()
                 .setName("name3373707")
                 .setCmekSettings(CmekSettings.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<CmekSettings> future =
             configClient.updateCmekSettingsCallable().futureCall(request);
         // Do something.
         CmekSettings response = future.get();
       }
       
    • getSettings

      public final Settings getSettings(SettingsName name)
      Gets the Log Router settings for the given resource.

      Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         SettingsName name = SettingsName.ofProjectName("[PROJECT]");
         Settings response = configClient.getSettings(name);
       }
       
      Parameters:
      name - Required. The resource for which to retrieve settings.

      "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings"

      For example:

      `"organizations/12345/settings"`

      Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getSettings

      public final Settings getSettings(String name)
      Gets the Log Router settings for the given resource.

      Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         String name = SettingsName.ofProjectName("[PROJECT]").toString();
         Settings response = configClient.getSettings(name);
       }
       
      Parameters:
      name - Required. The resource for which to retrieve settings.

      "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings"

      For example:

      `"organizations/12345/settings"`

      Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getSettings

      public final Settings getSettings(GetSettingsRequest request)
      Gets the Log Router settings for the given resource.

      Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetSettingsRequest request =
             GetSettingsRequest.newBuilder()
                 .setName(SettingsName.ofProjectName("[PROJECT]").toString())
                 .build();
         Settings response = configClient.getSettings(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • getSettingsCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetSettingsRequest,Settings> getSettingsCallable()
      Gets the Log Router settings for the given resource.

      Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         GetSettingsRequest request =
             GetSettingsRequest.newBuilder()
                 .setName(SettingsName.ofProjectName("[PROJECT]").toString())
                 .build();
         ApiFuture<Settings> future = configClient.getSettingsCallable().futureCall(request);
         // Do something.
         Settings response = future.get();
       }
       
    • updateSettings

      public final Settings updateSettings(Settings settings, com.google.protobuf.FieldMask updateMask)
      Updates the Log Router settings for the given resource.

      Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

      [UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled. 4) `location_id` is not supported by Logging. 5) `location_id` violate OrgPolicy.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         Settings settings = Settings.newBuilder().build();
         FieldMask updateMask = FieldMask.newBuilder().build();
         Settings response = configClient.updateSettings(settings, updateMask);
       }
       
      Parameters:
      settings - Required. The settings to update.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      updateMask - Optional. Field mask identifying which fields from `settings` should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

      See [FieldMask][google.protobuf.FieldMask] for more information.

      For example: `"updateMask=kmsKeyName"`

      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateSettings

      public final Settings updateSettings(UpdateSettingsRequest request)
      Updates the Log Router settings for the given resource.

      Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

      [UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled. 4) `location_id` is not supported by Logging. 5) `location_id` violate OrgPolicy.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateSettingsRequest request =
             UpdateSettingsRequest.newBuilder()
                 .setName("name3373707")
                 .setSettings(Settings.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         Settings response = configClient.updateSettings(request);
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • updateSettingsCallable

      public final com.google.api.gax.rpc.UnaryCallable<UpdateSettingsRequest,Settings> updateSettingsCallable()
      Updates the Log Router settings for the given resource.

      Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

      [UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled. 4) `location_id` is not supported by Logging. 5) `location_id` violate OrgPolicy.

      See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

      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 (ConfigClient configClient = ConfigClient.create()) {
         UpdateSettingsRequest request =
             UpdateSettingsRequest.newBuilder()
                 .setName("name3373707")
                 .setSettings(Settings.newBuilder().build())
                 .setUpdateMask(FieldMask.newBuilder().build())
                 .build();
         ApiFuture<Settings> future = configClient.updateSettingsCallable().futureCall(request);
         // Do something.
         Settings response = future.get();
       }
       
    • copyLogEntriesAsync

      public final com.google.api.gax.longrunning.OperationFuture<CopyLogEntriesResponse,CopyLogEntriesMetadata> copyLogEntriesAsync(CopyLogEntriesRequest request)
      Copies a set of log entries from a log bucket to a Cloud Storage bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CopyLogEntriesRequest request =
             CopyLogEntriesRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setDestination("destination-1429847026")
                 .build();
         CopyLogEntriesResponse response = configClient.copyLogEntriesAsync(request).get();
       }
       
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails
    • copyLogEntriesOperationCallable

      public final com.google.api.gax.rpc.OperationCallable<CopyLogEntriesRequest,CopyLogEntriesResponse,CopyLogEntriesMetadata> copyLogEntriesOperationCallable()
      Copies a set of log entries from a log bucket to a Cloud Storage bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CopyLogEntriesRequest request =
             CopyLogEntriesRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setDestination("destination-1429847026")
                 .build();
         OperationFuture<CopyLogEntriesResponse, CopyLogEntriesMetadata> future =
             configClient.copyLogEntriesOperationCallable().futureCall(request);
         // Do something.
         CopyLogEntriesResponse response = future.get();
       }
       
    • copyLogEntriesCallable

      public final com.google.api.gax.rpc.UnaryCallable<CopyLogEntriesRequest,com.google.longrunning.Operation> copyLogEntriesCallable()
      Copies a set of log entries from a log bucket to a Cloud Storage bucket.

      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 (ConfigClient configClient = ConfigClient.create()) {
         CopyLogEntriesRequest request =
             CopyLogEntriesRequest.newBuilder()
                 .setName("name3373707")
                 .setFilter("filter-1274492040")
                 .setDestination("destination-1429847026")
                 .build();
         ApiFuture<Operation> future = configClient.copyLogEntriesCallable().futureCall(request);
         // Do something.
         Operation response = future.get();
       }
       
    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable
    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface com.google.api.gax.core.BackgroundResource
    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface com.google.api.gax.core.BackgroundResource
    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface com.google.api.gax.core.BackgroundResource
    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface com.google.api.gax.core.BackgroundResource
    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException