Class ConfigClient (3.12.1)

public class ConfigClient implements 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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of 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.

Inheritance

java.lang.Object > ConfigClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ConfigClient create()

Constructs an instance of ConfigClient with default settings.

Returns

Type	Description
ConfigClient

Exceptions

Type	Description
IOException

create(ConfigSettings settings)

public static final ConfigClient create(ConfigSettings settings)

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.

Parameter

Name	Description
settings	`ConfigSettings`

Returns

Type	Description
ConfigClient

Exceptions

Type	Description
IOException

create(ConfigServiceV2Stub stub)

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

Parameter

Name	Description
stub	`ConfigServiceV2Stub`

Returns

Type	Description
ConfigClient

Constructors

ConfigClient(ConfigSettings settings)

protected ConfigClient(ConfigSettings settings)

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.

Parameter

Name	Description
settings	`ConfigSettings`

ConfigClient(ConfigServiceV2Stub stub)

protected ConfigClient(ConfigServiceV2Stub stub)

Parameter

Name	Description
stub	`ConfigServiceV2Stub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

copyLogEntriesAsync(CopyLogEntriesRequest request)

public final 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();
 }

Parameter

Name	Description
request	`CopyLogEntriesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<CopyLogEntriesResponse,CopyLogEntriesMetadata>

copyLogEntriesCallable()

public final UnaryCallable<CopyLogEntriesRequest,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();
 }

Returns

Type	Description
UnaryCallable<CopyLogEntriesRequest,Operation>

copyLogEntriesOperationCallable()

public final 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();
 }

Returns

Type	Description
OperationCallable<CopyLogEntriesRequest,CopyLogEntriesResponse,CopyLogEntriesMetadata>

createBucket(CreateBucketRequest request)

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);
 }

Parameter

Name	Description
request	`CreateBucketRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogBucket

createBucketCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<CreateBucketRequest,LogBucket>

createExclusion(BillingAccountName parent, LogExclusion exclusion)

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

Name Description

parent

BillingAccountName

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

LogExclusion

Required. The new exclusion, whose name parameter is an exclusion name that is not already used in the parent resource.

Returns

Type	Description
LogExclusion

createExclusion(CreateExclusionRequest request)

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);
 }

Parameter

Name	Description
request	`CreateExclusionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogExclusion

createExclusion(FolderName parent, LogExclusion exclusion)

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

Name Description

parent

FolderName

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

LogExclusion

Required. The new exclusion, whose name parameter is an exclusion name that is not already used in the parent resource.

Returns

Type	Description
LogExclusion

createExclusion(OrganizationName parent, LogExclusion exclusion)

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

Name Description

parent

OrganizationName

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

LogExclusion

Required. The new exclusion, whose name parameter is an exclusion name that is not already used in the parent resource.

Returns

Type	Description
LogExclusion

createExclusion(ProjectName parent, LogExclusion exclusion)

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

Name Description

parent

ProjectName

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

LogExclusion

Required. The new exclusion, whose name parameter is an exclusion name that is not already used in the parent resource.

Returns

Type	Description
LogExclusion

createExclusion(String parent, LogExclusion exclusion)

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

Name Description

parent

String

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

LogExclusion

Required. The new exclusion, whose name parameter is an exclusion name that is not already used in the parent resource.

Returns

Type	Description
LogExclusion

createExclusionCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<CreateExclusionRequest,LogExclusion>

createSink(BillingAccountName parent, LogSink sink)

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

Name Description

parent

BillingAccountName

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

LogSink

Required. The new sink, whose name parameter is a sink identifier that is not already in use.

Returns

Type	Description
LogSink

createSink(CreateSinkRequest request)

public final LogSink createSink(CreateSinkRequest request)

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);
 }

Parameter

Name	Description
request	`CreateSinkRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogSink

createSink(FolderName parent, LogSink sink)

public final LogSink createSink(FolderName parent, LogSink 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

Name Description

parent

FolderName

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

LogSink

Required. The new sink, whose name parameter is a sink identifier that is not already in use.

Returns

Type	Description
LogSink

createSink(OrganizationName parent, LogSink sink)

public final LogSink createSink(OrganizationName parent, LogSink 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

Name Description

parent

OrganizationName

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

LogSink

Required. The new sink, whose name parameter is a sink identifier that is not already in use.

Returns

Type	Description
LogSink

createSink(ProjectName parent, LogSink sink)

public final LogSink createSink(ProjectName parent, LogSink 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

Name Description

parent

ProjectName

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

LogSink

Required. The new sink, whose name parameter is a sink identifier that is not already in use.

Returns

Type	Description
LogSink

createSink(String parent, LogSink sink)

public final LogSink createSink(String parent, LogSink 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

Name Description

parent

String

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

LogSink

Required. The new sink, whose name parameter is a sink identifier that is not already in use.

Returns

Type	Description
LogSink

createSinkCallable()

public final UnaryCallable<CreateSinkRequest,LogSink> createSinkCallable()

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();
 }

Returns

Type	Description
UnaryCallable<CreateSinkRequest,LogSink>

createView(CreateViewRequest request)

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);
 }

Parameter

Name	Description
request	`CreateViewRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogView

createViewCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<CreateViewRequest,LogView>

deleteBucket(DeleteBucketRequest request)

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);
 }

Parameter

Name	Description
request	`DeleteBucketRequest` The request object containing all of the parameters for the API call.

deleteBucketCallable()

public final UnaryCallable<DeleteBucketRequest,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();
 }

Returns

Type	Description
UnaryCallable<DeleteBucketRequest,Empty>

deleteExclusion(DeleteExclusionRequest request)

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);
 }

Parameter

Name	Description
request	`DeleteExclusionRequest` The request object containing all of the parameters for the API call.

deleteExclusion(LogExclusionName name)

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);
 }

Parameter

Name Description

name

LogExclusionName

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"

deleteExclusion(String name)

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);
 }

Parameter

Name Description

name

String

Required. The resource name of an existing exclusion to delete:

For example:

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

deleteExclusionCallable()

public final UnaryCallable<DeleteExclusionRequest,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();
 }

Returns

Type	Description
UnaryCallable<DeleteExclusionRequest,Empty>

deleteSink(DeleteSinkRequest request)

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);
 }

Parameter

Name	Description
request	`DeleteSinkRequest` The request object containing all of the parameters for the API call.

deleteSink(LogSinkName sinkName)

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);
 }

Parameter

Name Description

sinkName

LogSinkName

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"

deleteSink(String sinkName)

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);
 }

Parameter

Name Description

sinkName

String

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"

deleteSinkCallable()

public final UnaryCallable<DeleteSinkRequest,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();
 }

Returns

Type	Description
UnaryCallable<DeleteSinkRequest,Empty>

deleteView(DeleteViewRequest request)

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);
 }

Parameter

Name	Description
request	`DeleteViewRequest` The request object containing all of the parameters for the API call.

deleteViewCallable()

public final UnaryCallable<DeleteViewRequest,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();
 }

Returns

Type	Description
UnaryCallable<DeleteViewRequest,Empty>

getBucket(GetBucketRequest request)

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);
 }

Parameter

Name	Description
request	`GetBucketRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogBucket

getBucketCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<GetBucketRequest,LogBucket>

getCmekSettings(GetCmekSettingsRequest request)

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 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);
 }

Parameter

Name	Description
request	`GetCmekSettingsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CmekSettings

getCmekSettingsCallable()

public final UnaryCallable<GetCmekSettingsRequest,CmekSettings> getCmekSettingsCallable()

Gets the Logging CMEK settings for the given resource.

See Enabling CMEK for Log Router 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();
 }

Returns

Type	Description
UnaryCallable<GetCmekSettingsRequest,CmekSettings>

getExclusion(GetExclusionRequest request)

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);
 }

Parameter

Name	Description
request	`GetExclusionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogExclusion

getExclusion(LogExclusionName name)

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);
 }

Parameter

Name Description

name

LogExclusionName

Required. The resource name of an existing exclusion:

For example:

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

Returns

Type	Description
LogExclusion

getExclusion(String name)

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);
 }

Parameter

Name Description

name

String

Required. The resource name of an existing exclusion:

For example:

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

Returns

Type	Description
LogExclusion

getExclusionCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<GetExclusionRequest,LogExclusion>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final ConfigSettings getSettings()

Returns

Type	Description
ConfigSettings

getSettings(GetSettingsRequest request)

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 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);
 }

Parameter

Name	Description
request	`GetSettingsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Settings

getSettings(SettingsName name)

public final Settings getSettings(SettingsName name)

Gets the Log Router settings for the given resource.

See Enabling CMEK for Log Router 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);
 }

Parameter

Name Description

name

SettingsName

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"

Returns

Type	Description
Settings

getSettings(String name)

public final Settings getSettings(String name)

Gets the Log Router settings for the given resource.

See Enabling CMEK for Log Router 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);
 }

Parameter

Name Description

name

String

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"

Returns

Type	Description
Settings

getSettingsCallable()

public final UnaryCallable<GetSettingsRequest,Settings> getSettingsCallable()

Gets the Log Router settings for the given resource.

See Enabling CMEK for Log Router 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();
 }

Returns

Type	Description
UnaryCallable<GetSettingsRequest,Settings>

getSink(GetSinkRequest request)

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);
 }

Parameter

Name	Description
request	`GetSinkRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogSink

getSink(LogSinkName sinkName)

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);
 }

Parameter

Name Description

sinkName

LogSinkName

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"

Returns

Type	Description
LogSink

getSink(String sinkName)

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);
 }

Parameter

Name Description

sinkName

String

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"

Returns

Type	Description
LogSink

getSinkCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<GetSinkRequest,LogSink>

getStub()

public ConfigServiceV2Stub getStub()

Returns

Type	Description
ConfigServiceV2Stub

getView(GetViewRequest request)

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);
 }

Parameter

Name	Description
request	`GetViewRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogView

getViewCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<GetViewRequest,LogView>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listBuckets(BillingAccountLocationName parent)

public final ConfigClient.ListBucketsPagedResponse listBuckets(BillingAccountLocationName 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()) {
   BillingAccountLocationName parent =
       BillingAccountLocationName.of("[BILLING_ACCOUNT]", "[LOCATION]");
   for (LogBucket element : configClient.listBuckets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

BillingAccountLocationName

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.

Returns

Type	Description
ConfigClient.ListBucketsPagedResponse

listBuckets(FolderLocationName parent)

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);
   }
 }

Parameter

Name Description

parent

FolderLocationName

Required. The parent resource whose buckets are to be listed:

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

Returns

Type	Description
ConfigClient.ListBucketsPagedResponse

listBuckets(ListBucketsRequest request)

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);
   }
 }

Parameter

Name	Description
request	`ListBucketsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ConfigClient.ListBucketsPagedResponse

listBuckets(LocationName parent)

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);
   }
 }

Parameter

Name Description

parent

LocationName

Required. The parent resource whose buckets are to be listed:

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

Returns

Type	Description
ConfigClient.ListBucketsPagedResponse

listBuckets(OrganizationLocationName parent)

public final ConfigClient.ListBucketsPagedResponse listBuckets(OrganizationLocationName 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()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (LogBucket element : configClient.listBuckets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

OrganizationLocationName

Required. The parent resource whose buckets are to be listed:

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

Returns

Type	Description
ConfigClient.ListBucketsPagedResponse

listBuckets(String parent)

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);
   }
 }

Parameter

Name Description

parent

String

Required. The parent resource whose buckets are to be listed:

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

Returns

Type	Description
ConfigClient.ListBucketsPagedResponse

listBucketsCallable()

public final 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;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListBucketsRequest,ListBucketsResponse>

listBucketsPagedCallable()

public final 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListBucketsRequest,ListBucketsPagedResponse>

listExclusions(BillingAccountName parent)

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);
   }
 }

Parameter

Name Description

parent

BillingAccountName

Required. The parent resource whose exclusions are to be listed.

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

Returns

Type	Description
ConfigClient.ListExclusionsPagedResponse

listExclusions(FolderName parent)

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);
   }
 }

Parameter

Name Description

parent

FolderName

Required. The parent resource whose exclusions are to be listed.

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

Returns

Type	Description
ConfigClient.ListExclusionsPagedResponse

listExclusions(ListExclusionsRequest request)

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);
   }
 }

Parameter

Name	Description
request	`ListExclusionsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ConfigClient.ListExclusionsPagedResponse

listExclusions(OrganizationName parent)

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);
   }
 }

Parameter

Name Description

parent

OrganizationName

Required. The parent resource whose exclusions are to be listed.

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

Returns

Type	Description
ConfigClient.ListExclusionsPagedResponse

listExclusions(ProjectName parent)

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);
   }
 }

Parameter

Name Description

parent

ProjectName

Required. The parent resource whose exclusions are to be listed.

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

Returns

Type	Description
ConfigClient.ListExclusionsPagedResponse

listExclusions(String parent)

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);
   }
 }

Parameter

Name Description

parent

String

Required. The parent resource whose exclusions are to be listed.

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

Returns

Type	Description
ConfigClient.ListExclusionsPagedResponse

listExclusionsCallable()

public final 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;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListExclusionsRequest,ListExclusionsResponse>

listExclusionsPagedCallable()

public final 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListExclusionsRequest,ListExclusionsPagedResponse>

listSinks(BillingAccountName parent)

public final ConfigClient.ListSinksPagedResponse listSinks(BillingAccountName 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()) {
   BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
   for (LogSink element : configClient.listSinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

BillingAccountName

Required. The parent resource whose sinks are to be listed:

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

Returns

Type	Description
ConfigClient.ListSinksPagedResponse

listSinks(FolderName parent)

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);
   }
 }

Parameter

Name Description

parent

FolderName

Required. The parent resource whose sinks are to be listed:

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

Returns

Type	Description
ConfigClient.ListSinksPagedResponse

listSinks(ListSinksRequest request)

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);
   }
 }

Parameter

Name	Description
request	`ListSinksRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ConfigClient.ListSinksPagedResponse

listSinks(OrganizationName parent)

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);
   }
 }

Parameter

Name Description

parent

OrganizationName

Required. The parent resource whose sinks are to be listed:

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

Returns

Type	Description
ConfigClient.ListSinksPagedResponse

listSinks(ProjectName parent)

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);
   }
 }

Parameter

Name Description

parent

ProjectName

Required. The parent resource whose sinks are to be listed:

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

Returns

Type	Description
ConfigClient.ListSinksPagedResponse

listSinks(String parent)

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);
   }
 }

Parameter

Name Description

parent

String

Required. The parent resource whose sinks are to be listed:

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

Returns

Type	Description
ConfigClient.ListSinksPagedResponse

listSinksCallable()

public final 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;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListSinksRequest,ListSinksResponse>

listSinksPagedCallable()

public final 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListSinksRequest,ListSinksPagedResponse>

listViews(ListViewsRequest request)

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);
   }
 }

Parameter

Name	Description
request	`ListViewsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
ConfigClient.ListViewsPagedResponse

listViews(String parent)

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);
   }
 }

Parameter

Name Description

parent

String

Required. The bucket whose views are to be listed:

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

Returns

Type	Description
ConfigClient.ListViewsPagedResponse

listViewsCallable()

public final 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;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListViewsRequest,ListViewsResponse>

listViewsPagedCallable()

public final 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListViewsRequest,ListViewsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

undeleteBucket(UndeleteBucketRequest request)

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);
 }

Parameter

Name	Description
request	`UndeleteBucketRequest` The request object containing all of the parameters for the API call.

undeleteBucketCallable()

public final UnaryCallable<UndeleteBucketRequest,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();
 }

Returns

Type	Description
UnaryCallable<UndeleteBucketRequest,Empty>

updateBucket(UpdateBucketRequest request)

public final LogBucket updateBucket(UpdateBucketRequest request)

Updates a log bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_period

If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.

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);
 }

Parameter

Name	Description
request	`UpdateBucketRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogBucket

updateBucketCallable()

public final UnaryCallable<UpdateBucketRequest,LogBucket> updateBucketCallable()

Updates a log bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_period

If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.

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();
 }

Returns

Type	Description
UnaryCallable<UpdateBucketRequest,LogBucket>

updateCmekSettings(UpdateCmekSettingsRequest request)

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 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 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);
 }

Parameter

Name	Description
request	`UpdateCmekSettingsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CmekSettings

updateCmekSettingsCallable()

public final 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.

See Enabling CMEK for Log Router 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();
 }

Returns

Type	Description
UnaryCallable<UpdateCmekSettingsRequest,CmekSettings>

updateExclusion(LogExclusionName name, LogExclusion exclusion, FieldMask updateMask)

public final LogExclusion updateExclusion(LogExclusionName name, LogExclusion exclusion, 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	Description
name	`LogExclusionName` 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	`LogExclusion` Required. New values for the existing exclusion. Only the fields specified in `update_mask` are relevant.
updateMask	`FieldMask` 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 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"`.

Returns

Type	Description
LogExclusion

updateExclusion(UpdateExclusionRequest request)

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);
 }

Parameter

Name	Description
request	`UpdateExclusionRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogExclusion

updateExclusion(String name, LogExclusion exclusion, FieldMask updateMask)

public final LogExclusion updateExclusion(String name, LogExclusion exclusion, 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	Description
name	`String` 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	`LogExclusion` Required. New values for the existing exclusion. Only the fields specified in `update_mask` are relevant.
updateMask	`FieldMask` 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 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"`.

Returns

Type	Description
LogExclusion

updateExclusionCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<UpdateExclusionRequest,LogExclusion>

updateSettings(Settings settings, FieldMask updateMask)

public final Settings updateSettings(Settings settings, 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 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 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

Name Description

settings

Settings

Required. The settings to update.

See Enabling CMEK for Log Router for more information.

updateMask

FieldMask

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 for more information.

For example: "updateMask=kmsKeyName"

Returns

Type	Description
Settings

updateSettings(UpdateSettingsRequest request)

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.

See Enabling CMEK for Log Router 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);
 }

Parameter

Name	Description
request	`UpdateSettingsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Settings

updateSettingsCallable()

public final 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.

See Enabling CMEK for Log Router 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();
 }

Returns

Type	Description
UnaryCallable<UpdateSettingsRequest,Settings>

updateSink(LogSinkName sinkName, LogSink sink)

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

Name Description

sinkName

LogSinkName

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

LogSink

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

Returns

Type	Description
LogSink

updateSink(LogSinkName sinkName, LogSink sink, FieldMask updateMask)

public final LogSink updateSink(LogSinkName sinkName, LogSink sink, 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

Name	Description
sinkName	`LogSinkName` 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	`LogSink` Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.
updateMask	`FieldMask` 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`

Returns

Type	Description
LogSink

updateSink(UpdateSinkRequest request)

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);
 }

Parameter

Name	Description
request	`UpdateSinkRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogSink

updateSink(String sinkName, LogSink sink)

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

Name Description

sinkName

String

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

LogSink

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

Returns

Type	Description
LogSink

updateSink(String sinkName, LogSink sink, FieldMask updateMask)

public final LogSink updateSink(String sinkName, LogSink sink, 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

Name	Description
sinkName	`String` 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	`LogSink` Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`.
updateMask	`FieldMask` 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`

Returns

Type	Description
LogSink

updateSinkCallable()

public final 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();
 }

Returns

Type	Description
UnaryCallable<UpdateSinkRequest,LogSink>

updateView(UpdateViewRequest request)

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);
 }

Parameter

Name	Description
request	`UpdateViewRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
LogView

updateViewCallable()

public final UnaryCallable<UpdateViewRequest,LogView> updateViewCallable()

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();
 }

Returns

Type	Description
UnaryCallable<UpdateViewRequest,LogView>