com.google.cloud.logging.v2

Class LoggingSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<LoggingSettings>

com.google.cloud.logging.v2.LoggingSettings

@Generated(value="by gapic-generator-java")
public class LoggingSettings
extends com.google.api.gax.rpc.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:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LoggingSettings.Builder loggingSettingsBuilder = LoggingSettings.newBuilder();
 loggingSettingsBuilder
     .deleteLogSettings()
     .setRetrySettings(
         loggingSettingsBuilder
             .deleteLogSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 LoggingSettings loggingSettings = loggingSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingSettings.Builder Builder for LoggingSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LoggingSettings(LoggingSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static LoggingSettings	create(LoggingServiceV2StubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteLogRequest,com.google.protobuf.Empty>	deleteLogSettings() Returns the object with the settings used for calls to deleteLog.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.PagedCallSettings<ListLogEntriesRequest,ListLogEntriesResponse,LoggingClient.ListLogEntriesPagedResponse>	listLogEntriesSettings() Returns the object with the settings used for calls to listLogEntries.
com.google.api.gax.rpc.PagedCallSettings<ListLogsRequest,ListLogsResponse,LoggingClient.ListLogsPagedResponse>	listLogsSettings() Returns the object with the settings used for calls to listLogs.
com.google.api.gax.rpc.PagedCallSettings<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse,LoggingClient.ListMonitoredResourceDescriptorsPagedResponse>	listMonitoredResourceDescriptorsSettings() Returns the object with the settings used for calls to listMonitoredResourceDescriptors.
static LoggingSettings.Builder	newBuilder() Returns a new builder for this class.
static LoggingSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.StreamingCallSettings<TailLogEntriesRequest,TailLogEntriesResponse>	tailLogEntriesSettings() Returns the object with the settings used for calls to tailLogEntries.
LoggingSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.BatchingCallSettings<WriteLogEntriesRequest,WriteLogEntriesResponse>	writeLogEntriesSettings() Returns the object with the settings used for calls to writeLogEntries.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LoggingSettings

protected LoggingSettings(LoggingSettings.Builder settingsBuilder)
                   throws IOException

Throws:

IOException

Method Detail

deleteLogSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteLogRequest,com.google.protobuf.Empty> deleteLogSettings()

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

writeLogEntriesSettings

public com.google.api.gax.rpc.BatchingCallSettings<WriteLogEntriesRequest,WriteLogEntriesResponse> writeLogEntriesSettings()

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

listLogEntriesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListLogEntriesRequest,ListLogEntriesResponse,LoggingClient.ListLogEntriesPagedResponse> listLogEntriesSettings()

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

listMonitoredResourceDescriptorsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse,LoggingClient.ListMonitoredResourceDescriptorsPagedResponse> listMonitoredResourceDescriptorsSettings()

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

listLogsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListLogsRequest,ListLogsResponse,LoggingClient.ListLogsPagedResponse> listLogsSettings()

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

tailLogEntriesSettings

public com.google.api.gax.rpc.StreamingCallSettings<TailLogEntriesRequest,TailLogEntriesResponse> tailLogEntriesSettings()

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

create

public static final LoggingSettings create(LoggingServiceV2StubSettings stub)
                                    throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static LoggingSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static LoggingSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public LoggingSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<LoggingSettings>