Class LoggingSettings (3.5.3)

public class LoggingSettings extends ClientSettings<LoggingSettings>

Settings class to configure an instance of LoggingClient.

The default instance has everything set to sensible defaults:

The default service address (logging.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of deleteLog to 30 seconds:


 LoggingSettings.Builder loggingSettingsBuilder = LoggingSettings.newBuilder();
 loggingSettingsBuilder
     .deleteLogSettings()
     .setRetrySettings(
         loggingSettingsBuilder
             .deleteLogSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 LoggingSettings loggingSettings = loggingSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > LoggingSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

LoggingSettings(LoggingSettings.Builder settingsBuilder)

protected LoggingSettings(LoggingSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`LoggingSettings.Builder`

Methods

create(LoggingServiceV2StubSettings stub)

public static final LoggingSettings create(LoggingServiceV2StubSettings stub)

Parameter

Name	Description
stub	`LoggingServiceV2StubSettings`

Returns

Type	Description
LoggingSettings

Exceptions

Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

deleteLogSettings()

public UnaryCallSettings<DeleteLogRequest,Empty> deleteLogSettings()

Returns the object with the settings used for calls to deleteLog.

Returns

Type	Description
UnaryCallSettings<DeleteLogRequest,Empty>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

listLogEntriesSettings()

public PagedCallSettings<ListLogEntriesRequest,ListLogEntriesResponse,LoggingClient.ListLogEntriesPagedResponse> listLogEntriesSettings()

Returns the object with the settings used for calls to listLogEntries.

Returns

Type	Description
PagedCallSettings<ListLogEntriesRequest,ListLogEntriesResponse,ListLogEntriesPagedResponse>

listLogsSettings()

public PagedCallSettings<ListLogsRequest,ListLogsResponse,LoggingClient.ListLogsPagedResponse> listLogsSettings()

Returns the object with the settings used for calls to listLogs.

Returns

Type	Description
PagedCallSettings<ListLogsRequest,ListLogsResponse,ListLogsPagedResponse>

listMonitoredResourceDescriptorsSettings()

public PagedCallSettings<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse,LoggingClient.ListMonitoredResourceDescriptorsPagedResponse> listMonitoredResourceDescriptorsSettings()

Returns the object with the settings used for calls to listMonitoredResourceDescriptors.

Returns

Type	Description
PagedCallSettings<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse,ListMonitoredResourceDescriptorsPagedResponse>

newBuilder()

public static LoggingSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
LoggingSettings.Builder

newBuilder(ClientContext clientContext)

public static LoggingSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
LoggingSettings.Builder

tailLogEntriesSettings()

public StreamingCallSettings<TailLogEntriesRequest,TailLogEntriesResponse> tailLogEntriesSettings()

Returns the object with the settings used for calls to tailLogEntries.

Returns

Type	Description
StreamingCallSettings<TailLogEntriesRequest,TailLogEntriesResponse>

toBuilder()

public LoggingSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns

Type	Description
LoggingSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

writeLogEntriesSettings()

public BatchingCallSettings<WriteLogEntriesRequest,WriteLogEntriesResponse> writeLogEntriesSettings()

Returns the object with the settings used for calls to writeLogEntries.

Returns

Type	Description
BatchingCallSettings<WriteLogEntriesRequest,WriteLogEntriesResponse>