Class ServicesSettings (2.9.0) 

public class ServicesSettings extends ClientSettings<ServicesSettings>

Settings class to configure an instance of ServicesClient.

The default instance has everything set to sensible defaults:

  • The default service address (appengine.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 getService 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
 ServicesSettings.Builder servicesSettingsBuilder = ServicesSettings.newBuilder();
 servicesSettingsBuilder
     .getServiceSettings()
     .setRetrySettings(
         servicesSettingsBuilder
             .getServiceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ServicesSettings servicesSettings = servicesSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > ServicesSettings

Static Methods

create(ServicesStubSettings stub)

public static final ServicesSettings create(ServicesStubSettings stub)
Parameter
NameDescription
stubServicesStubSettings
Returns
TypeDescription
ServicesSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ServicesSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
ServicesSettings.Builder

newBuilder(ClientContext clientContext)

public static ServicesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ServicesSettings.Builder

newHttpJsonBuilder()

public static ServicesSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
ServicesSettings.Builder

Constructors

ServicesSettings(ServicesSettings.Builder settingsBuilder)

protected ServicesSettings(ServicesSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderServicesSettings.Builder

Methods

deleteServiceOperationSettings()

public OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadataV1> deleteServiceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadataV1>

deleteServiceSettings()

public UnaryCallSettings<DeleteServiceRequest,Operation> deleteServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteServiceRequest,Operation>

getServiceSettings()

public UnaryCallSettings<GetServiceRequest,Service> getServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServiceRequest,Service>

listServicesSettings()

public PagedCallSettings<ListServicesRequest,ListServicesResponse,ServicesClient.ListServicesPagedResponse> listServicesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListServicesRequest,ListServicesResponse,ListServicesPagedResponse>

toBuilder()

public ServicesSettings.Builder toBuilder()

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

Returns
TypeDescription
ServicesSettings.Builder
Overrides

updateServiceOperationSettings()

public OperationCallSettings<UpdateServiceRequest,Service,OperationMetadataV1> updateServiceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateServiceRequest,Service,OperationMetadataV1>

updateServiceSettings()

public UnaryCallSettings<UpdateServiceRequest,Operation> updateServiceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateServiceRequest,Operation>