Class CloudMemcacheSettings (2.22.0)

public class CloudMemcacheSettings extends ClientSettings<CloudMemcacheSettings>

Settings class to configure an instance of CloudMemcacheClient.

The default instance has everything set to sensible defaults:

  • The default service address (memcache.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 getInstance 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
 CloudMemcacheSettings.Builder cloudMemcacheSettingsBuilder = CloudMemcacheSettings.newBuilder();
 cloudMemcacheSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         cloudMemcacheSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudMemcacheSettings cloudMemcacheSettings = cloudMemcacheSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > CloudMemcacheSettings

Static Methods

create(CloudMemcacheStubSettings stub)

public static final CloudMemcacheSettings create(CloudMemcacheStubSettings stub)
Parameter
NameDescription
stubCloudMemcacheStubSettings
Returns
TypeDescription
CloudMemcacheSettings
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 CloudMemcacheSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CloudMemcacheSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudMemcacheSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudMemcacheSettings.Builder

newHttpJsonBuilder()

public static CloudMemcacheSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CloudMemcacheSettings.Builder

Constructors

CloudMemcacheSettings(CloudMemcacheSettings.Builder settingsBuilder)

protected CloudMemcacheSettings(CloudMemcacheSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudMemcacheSettings.Builder

Methods

applyParametersOperationSettings()

public OperationCallSettings<ApplyParametersRequest,Instance,OperationMetadata> applyParametersOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ApplyParametersRequest,Instance,OperationMetadata>

applyParametersSettings()

public UnaryCallSettings<ApplyParametersRequest,Operation> applyParametersSettings()

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

Returns
TypeDescription
UnaryCallSettings<ApplyParametersRequest,Operation>

createInstanceOperationSettings()

public OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata>

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInstanceRequest,Operation>

deleteInstanceOperationSettings()

public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata>

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInstanceRequest,Operation>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstanceRequest,Instance>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,CloudMemcacheClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,CloudMemcacheClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

rescheduleMaintenanceOperationSettings()

public OperationCallSettings<RescheduleMaintenanceRequest,Instance,OperationMetadata> rescheduleMaintenanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<RescheduleMaintenanceRequest,Instance,OperationMetadata>

rescheduleMaintenanceSettings()

public UnaryCallSettings<RescheduleMaintenanceRequest,Operation> rescheduleMaintenanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<RescheduleMaintenanceRequest,Operation>

toBuilder()

public CloudMemcacheSettings.Builder toBuilder()

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

Returns
TypeDescription
CloudMemcacheSettings.Builder
Overrides

updateInstanceOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata>

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInstanceRequest,Operation>

updateParametersOperationSettings()

public OperationCallSettings<UpdateParametersRequest,Instance,OperationMetadata> updateParametersOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateParametersRequest,Instance,OperationMetadata>

updateParametersSettings()

public UnaryCallSettings<UpdateParametersRequest,Operation> updateParametersSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateParametersRequest,Operation>