ConfigClient (Google Cloud Logging 1.3.1 API)

java.lang.Object
- com.google.cloud.logging.v2.ConfigClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by GAPIC v0.0.5")
 @BetaApi
public class ConfigClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Service for configuring sinks used to export log entries outside of Stackdriver Logging.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   LogSink response = configClient.getSink(sinkName);
 }
 
 
```
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:
1. 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.
2. 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.
3. 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:
```
 
 ConfigSettings configSettings =
     ConfigSettings.defaultBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConfigClient configClient =
     ConfigClient.create(configSettings);
 
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ConfigClient(ConfigServiceV2Stub stub)`
`protected`	`ConfigClient(ConfigSettings settings)` Constructs an instance of ConfigClient, using the given settings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ConfigClient`	`create()` Constructs an instance of ConfigClient with default settings.
`static ConfigClient`	`create(ConfigServiceV2Stub stub)` Constructs an instance of ConfigClient, using the given stub for making calls.
`static ConfigClient`	`create(ConfigSettings settings)` Constructs an instance of ConfigClient, using the given settings.
`com.google.logging.v2.LogSink`	`createSink(com.google.logging.v2.CreateSinkRequest request)` Creates a sink that exports specified log entries to a destination.
`com.google.logging.v2.LogSink`	`createSink(com.google.logging.v2.ParentNameOneof parent, com.google.logging.v2.LogSink sink)` Creates a sink that exports specified log entries to a destination.
`com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.CreateSinkRequest,com.google.logging.v2.LogSink>`	`createSinkCallable()` Creates a sink that exports specified log entries to a destination.
`void`	`deleteSink(com.google.logging.v2.SinkNameOneof sinkName)` Deletes a sink.
`com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.DeleteSinkRequest,com.google.protobuf.Empty>`	`deleteSinkCallable()` Deletes a sink.
`ConfigSettings`	`getSettings()`
`com.google.logging.v2.LogSink`	`getSink(com.google.logging.v2.SinkNameOneof sinkName)` Gets a sink.
`com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.GetSinkRequest,com.google.logging.v2.LogSink>`	`getSinkCallable()` Gets a sink.
`ConfigServiceV2Stub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`PagedResponseWrappers.ListSinksPagedResponse`	`listSinks(com.google.logging.v2.ListSinksRequest request)` Lists sinks.
`PagedResponseWrappers.ListSinksPagedResponse`	`listSinks(com.google.logging.v2.ParentNameOneof parent)` Lists sinks.
`com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.ListSinksRequest,com.google.logging.v2.ListSinksResponse>`	`listSinksCallable()` Lists sinks.
`com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.ListSinksRequest,PagedResponseWrappers.ListSinksPagedResponse>`	`listSinksPagedCallable()` Lists sinks.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.logging.v2.LogSink`	`updateSink(com.google.logging.v2.SinkNameOneof sinkName, com.google.logging.v2.LogSink sink)` Updates a sink.
`com.google.logging.v2.LogSink`	`updateSink(com.google.logging.v2.UpdateSinkRequest request)` Updates a sink.
`com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.UpdateSinkRequest,com.google.logging.v2.LogSink>`	`updateSinkCallable()` Updates a sink.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ConfigClient
```
protected ConfigClient(ConfigSettings settings)
                throws IOException
```
  Constructs an instance of ConfigClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- ConfigClient
```
protected ConfigClient(ConfigServiceV2Stub stub)
```

Method Detail

create

public static final ConfigClient create()
                                 throws IOException

Constructs an instance of ConfigClient with default settings.

Throws:: IOException

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

Throws:

IOException

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

getSettings

public final ConfigSettings getSettings()

getStub
```
public ConfigServiceV2Stub getStub()
```

listSinks

public final PagedResponseWrappers.ListSinksPagedResponse listSinks(com.google.logging.v2.ParentNameOneof parent)

Lists sinks.

Sample code:


 try (ConfigClient configClient = ConfigClient.create()) {
   ParentNameOneof parent = ParentNameOneof.from(ProjectName.create("[PROJECT]"));
   for (LogSink element : configClient.listSinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent resource whose sinks are to be listed:
"projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listSinks

public final PagedResponseWrappers.ListSinksPagedResponse listSinks(com.google.logging.v2.ListSinksRequest request)

Lists sinks.

Sample code:


 try (ConfigClient configClient = ConfigClient.create()) {
   ParentNameOneof parent = ParentNameOneof.from(ProjectName.create("[PROJECT]"));
   ListSinksRequest request = ListSinksRequest.newBuilder()
     .setParentWithParentNameOneof(parent)
     .build();
   for (LogSink element : configClient.listSinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listSinksPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.ListSinksRequest,PagedResponseWrappers.ListSinksPagedResponse> listSinksPagedCallable()

Lists sinks.

Sample code:


 try (ConfigClient configClient = ConfigClient.create()) {
   ParentNameOneof parent = ParentNameOneof.from(ProjectName.create("[PROJECT]"));
   ListSinksRequest request = ListSinksRequest.newBuilder()
     .setParentWithParentNameOneof(parent)
     .build();
   ApiFuture<ListSinksPagedResponse> future = configClient.listSinksPagedCallable().futureCall(request);
   // Do something
   for (LogSink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listSinksCallable

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

Lists sinks.

Sample code:


 try (ConfigClient configClient = ConfigClient.create()) {
   ParentNameOneof parent = ParentNameOneof.from(ProjectName.create("[PROJECT]"));
   ListSinksRequest request = ListSinksRequest.newBuilder()
     .setParentWithParentNameOneof(parent)
     .build();
   while (true) {
     ListSinksResponse response = configClient.listSinksCallable().call(request);
     for (LogSink element : response.getSinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getSink
```
public final com.google.logging.v2.LogSink getSink(com.google.logging.v2.SinkNameOneof sinkName)
```
Gets a sink.
Sample code:
```
 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   LogSink response = configClient.getSink(sinkName);
 }
 
```
Parameters:

sinkName - Required. The resource name of the sink:
"projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example: `"projects/my-project-id/sinks/my-sink-id"`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSinkCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.GetSinkRequest,com.google.logging.v2.LogSink> getSinkCallable()

Gets a sink.

Sample code:


 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   GetSinkRequest request = GetSinkRequest.newBuilder()
     .setSinkNameWithSinkNameOneof(sinkName)
     .build();
   ApiFuture<LogSink> future = configClient.getSinkCallable().futureCall(request);
   // Do something
   LogSink response = future.get();
 }

createSink
```
public final com.google.logging.v2.LogSink createSink(com.google.logging.v2.ParentNameOneof parent,
                                                      com.google.logging.v2.LogSink sink)
```
Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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:
```
 try (ConfigClient configClient = ConfigClient.create()) {
   ParentNameOneof parent = ParentNameOneof.from(ProjectName.create("[PROJECT]"));
   LogSink sink = LogSink.newBuilder().build();
   LogSink response = configClient.createSink(parent, sink);
 }
 
```
Parameters:

parent - Required. The resource in which to create the sink:
"projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
Examples: `"projects/my-logging-project"`, `"organizations/123456789"`.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createSink
```
public final com.google.logging.v2.LogSink createSink(com.google.logging.v2.CreateSinkRequest request)
```
Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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:
```
 try (ConfigClient configClient = ConfigClient.create()) {
   ParentNameOneof parent = ParentNameOneof.from(ProjectName.create("[PROJECT]"));
   LogSink sink = LogSink.newBuilder().build();
   CreateSinkRequest request = CreateSinkRequest.newBuilder()
     .setParentWithParentNameOneof(parent)
     .setSink(sink)
     .build();
   LogSink response = configClient.createSink(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createSinkCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.CreateSinkRequest,com.google.logging.v2.LogSink> createSinkCallable()

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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:


 try (ConfigClient configClient = ConfigClient.create()) {
   ParentNameOneof parent = ParentNameOneof.from(ProjectName.create("[PROJECT]"));
   LogSink sink = LogSink.newBuilder().build();
   CreateSinkRequest request = CreateSinkRequest.newBuilder()
     .setParentWithParentNameOneof(parent)
     .setSink(sink)
     .build();
   ApiFuture<LogSink> future = configClient.createSinkCallable().futureCall(request);
   // Do something
   LogSink response = future.get();
 }

updateSink
```
public final com.google.logging.v2.LogSink updateSink(com.google.logging.v2.SinkNameOneof sinkName,
                                                      com.google.logging.v2.LogSink sink)
```
Updates a sink. If the named sink doesn't exist, then this method is identical to [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create). If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: `destination`, `filter`, `output_version_format`, `start_time`, and `end_time`. The updated filter might also have a new `writer_identity`; see the `unique_writer_identity` field.
Sample code:
```
 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   LogSink sink = LogSink.newBuilder().build();
   LogSink response = configClient.updateSink(sinkName, sink);
 }
 
```
Parameters:

sinkName - Required. The full resource name of the sink to update, including the parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example: `"projects/my-project-id/sinks/my-sink-id"`.

sink - Required. The updated sink, whose name is the same identifier that appears as part of `sink_name`. If `sink_name` does not exist, then this method creates a new sink.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateSink
```
public final com.google.logging.v2.LogSink updateSink(com.google.logging.v2.UpdateSinkRequest request)
```
Updates a sink. If the named sink doesn't exist, then this method is identical to [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create). If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: `destination`, `filter`, `output_version_format`, `start_time`, and `end_time`. The updated filter might also have a new `writer_identity`; see the `unique_writer_identity` field.
Sample code:
```
 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   LogSink sink = LogSink.newBuilder().build();
   UpdateSinkRequest request = UpdateSinkRequest.newBuilder()
     .setSinkNameWithSinkNameOneof(sinkName)
     .setSink(sink)
     .build();
   LogSink response = configClient.updateSink(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateSinkCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.UpdateSinkRequest,com.google.logging.v2.LogSink> updateSinkCallable()

Updates a sink. If the named sink doesn't exist, then this method is identical to [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create). If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: `destination`, `filter`, `output_version_format`, `start_time`, and `end_time`. The updated filter might also have a new `writer_identity`; see the `unique_writer_identity` field.

Sample code:


 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   LogSink sink = LogSink.newBuilder().build();
   UpdateSinkRequest request = UpdateSinkRequest.newBuilder()
     .setSinkNameWithSinkNameOneof(sinkName)
     .setSink(sink)
     .build();
   ApiFuture<LogSink> future = configClient.updateSinkCallable().futureCall(request);
   // Do something
   LogSink response = future.get();
 }

deleteSink
```
public final void deleteSink(com.google.logging.v2.SinkNameOneof sinkName)
```
Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.
Sample code:
```
 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   configClient.deleteSink(sinkName);
 }
 
```
Parameters:

sinkName - Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example: `"projects/my-project-id/sinks/my-sink-id"`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSinkCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.logging.v2.DeleteSinkRequest,com.google.protobuf.Empty> deleteSinkCallable()

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

Sample code:


 try (ConfigClient configClient = ConfigClient.create()) {
   SinkNameOneof sinkName = SinkNameOneof.from(SinkName.create("[PROJECT]", "[SINK]"));
   DeleteSinkRequest request = DeleteSinkRequest.newBuilder()
     .setSinkNameWithSinkNameOneof(sinkName)
     .build();
   ApiFuture<Void> future = configClient.deleteSinkCallable().futureCall(request);
   // Do something
   future.get();
 }

close
```
public final void close()
                 throws Exception
```
Specified by:

close in interface AutoCloseable

Throws:

Exception

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class ConfigClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigClient

ConfigClient

Method Detail

create

create

create

getSettings

getStub

listSinks

listSinks

listSinksPagedCallable

listSinksCallable

getSink

getSinkCallable

createSink

createSink

createSinkCallable

updateSink

updateSink

updateSinkCallable

deleteSink

deleteSinkCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination