Class NativeDashboardServiceStubSettings (0.31.0)

public class NativeDashboardServiceStubSettings extends StubSettings<NativeDashboardServiceStubSettings>

Settings class to configure an instance of NativeDashboardServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (chronicle.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 RetrySettings of createNativeDashboard:


 // 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
 NativeDashboardServiceStubSettings.Builder nativeDashboardServiceSettingsBuilder =
     NativeDashboardServiceStubSettings.newBuilder();
 nativeDashboardServiceSettingsBuilder
     .createNativeDashboardSettings()
     .setRetrySettings(
         nativeDashboardServiceSettingsBuilder
             .createNativeDashboardSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 NativeDashboardServiceStubSettings nativeDashboardServiceSettings =
     nativeDashboardServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > NativeDashboardServiceStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static NativeDashboardServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
NativeDashboardServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static NativeDashboardServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
NativeDashboardServiceStubSettings.Builder

newHttpJsonBuilder()

public static NativeDashboardServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
NativeDashboardServiceStubSettings.Builder

Constructors

NativeDashboardServiceStubSettings(NativeDashboardServiceStubSettings.Builder settingsBuilder)

protected NativeDashboardServiceStubSettings(NativeDashboardServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder NativeDashboardServiceStubSettings.Builder

Methods

addChartSettings()

public UnaryCallSettings<AddChartRequest,AddChartResponse> addChartSettings()

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

Returns
Type Description
UnaryCallSettings<AddChartRequest,AddChartResponse>

createNativeDashboardSettings()

public UnaryCallSettings<CreateNativeDashboardRequest,NativeDashboard> createNativeDashboardSettings()

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

Returns
Type Description
UnaryCallSettings<CreateNativeDashboardRequest,NativeDashboard>

createStub()

public NativeDashboardServiceStub createStub()
Returns
Type Description
NativeDashboardServiceStub
Exceptions
Type Description
IOException

deleteNativeDashboardSettings()

public UnaryCallSettings<DeleteNativeDashboardRequest,Empty> deleteNativeDashboardSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteNativeDashboardRequest,Empty>

duplicateChartSettings()

public UnaryCallSettings<DuplicateChartRequest,DuplicateChartResponse> duplicateChartSettings()

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

Returns
Type Description
UnaryCallSettings<DuplicateChartRequest,DuplicateChartResponse>

duplicateNativeDashboardSettings()

public UnaryCallSettings<DuplicateNativeDashboardRequest,NativeDashboard> duplicateNativeDashboardSettings()

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

Returns
Type Description
UnaryCallSettings<DuplicateNativeDashboardRequest,NativeDashboard>

editChartSettings()

public UnaryCallSettings<EditChartRequest,EditChartResponse> editChartSettings()

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

Returns
Type Description
UnaryCallSettings<EditChartRequest,EditChartResponse>

exportNativeDashboardsSettings()

public UnaryCallSettings<ExportNativeDashboardsRequest,ExportNativeDashboardsResponse> exportNativeDashboardsSettings()

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

Returns
Type Description
UnaryCallSettings<ExportNativeDashboardsRequest,ExportNativeDashboardsResponse>

getLibraryMetadata()

protected LibraryMetadata getLibraryMetadata()
Returns
Type Description
LibraryMetadata
Overrides

getNativeDashboardSettings()

public UnaryCallSettings<GetNativeDashboardRequest,NativeDashboard> getNativeDashboardSettings()

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

Returns
Type Description
UnaryCallSettings<GetNativeDashboardRequest,NativeDashboard>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

importNativeDashboardsSettings()

public UnaryCallSettings<ImportNativeDashboardsRequest,ImportNativeDashboardsResponse> importNativeDashboardsSettings()

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

Returns
Type Description
UnaryCallSettings<ImportNativeDashboardsRequest,ImportNativeDashboardsResponse>

listNativeDashboardsSettings()

public PagedCallSettings<ListNativeDashboardsRequest,ListNativeDashboardsResponse,NativeDashboardServiceClient.ListNativeDashboardsPagedResponse> listNativeDashboardsSettings()

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

Returns
Type Description
PagedCallSettings<ListNativeDashboardsRequest,ListNativeDashboardsResponse,ListNativeDashboardsPagedResponse>

removeChartSettings()

public UnaryCallSettings<RemoveChartRequest,NativeDashboard> removeChartSettings()

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

Returns
Type Description
UnaryCallSettings<RemoveChartRequest,NativeDashboard>

toBuilder()

public NativeDashboardServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
NativeDashboardServiceStubSettings.Builder
Overrides

updateNativeDashboardSettings()

public UnaryCallSettings<UpdateNativeDashboardRequest,NativeDashboard> updateNativeDashboardSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateNativeDashboardRequest,NativeDashboard>