Class ScheduleServiceSettings (3.23.0)

public class ScheduleServiceSettings extends ClientSettings<ScheduleServiceSettings>

Settings class to configure an instance of ScheduleServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (aiplatform.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 createSchedule 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
 ScheduleServiceSettings.Builder scheduleServiceSettingsBuilder =
     ScheduleServiceSettings.newBuilder();
 scheduleServiceSettingsBuilder
     .createScheduleSettings()
     .setRetrySettings(
         scheduleServiceSettingsBuilder
             .createScheduleSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ScheduleServiceSettings scheduleServiceSettings = scheduleServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > ScheduleServiceSettings

Static Methods

create(ScheduleServiceStubSettings stub)

public static final ScheduleServiceSettings create(ScheduleServiceStubSettings stub)
Parameter
NameDescription
stubScheduleServiceStubSettings
Returns
TypeDescription
ScheduleServiceSettings
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 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 ScheduleServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ScheduleServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static ScheduleServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ScheduleServiceSettings.Builder

Constructors

ScheduleServiceSettings(ScheduleServiceSettings.Builder settingsBuilder)

protected ScheduleServiceSettings(ScheduleServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderScheduleServiceSettings.Builder

Methods

createScheduleSettings()

public UnaryCallSettings<CreateScheduleRequest,Schedule> createScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateScheduleRequest,Schedule>

deleteScheduleOperationSettings()

public OperationCallSettings<DeleteScheduleRequest,Empty,DeleteOperationMetadata> deleteScheduleOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteScheduleRequest,Empty,DeleteOperationMetadata>

deleteScheduleSettings()

public UnaryCallSettings<DeleteScheduleRequest,Operation> deleteScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteScheduleRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

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>

getScheduleSettings()

public UnaryCallSettings<GetScheduleRequest,Schedule> getScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetScheduleRequest,Schedule>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ScheduleServiceClient.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>

listSchedulesSettings()

public PagedCallSettings<ListSchedulesRequest,ListSchedulesResponse,ScheduleServiceClient.ListSchedulesPagedResponse> listSchedulesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListSchedulesRequest,ListSchedulesResponse,ListSchedulesPagedResponse>

pauseScheduleSettings()

public UnaryCallSettings<PauseScheduleRequest,Empty> pauseScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<PauseScheduleRequest,Empty>

resumeScheduleSettings()

public UnaryCallSettings<ResumeScheduleRequest,Empty> resumeScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResumeScheduleRequest,Empty>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public ScheduleServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
ScheduleServiceSettings.Builder
Overrides

updateScheduleSettings()

public UnaryCallSettings<UpdateScheduleRequest,Schedule> updateScheduleSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateScheduleRequest,Schedule>