Class PredictionServiceStubSettings (3.40.0)

public class PredictionServiceStubSettings extends StubSettings<PredictionServiceStubSettings>

Settings class to configure an instance of PredictionServiceStub.

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 predict 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
 PredictionServiceStubSettings.Builder predictionServiceSettingsBuilder =
     PredictionServiceStubSettings.newBuilder();
 predictionServiceSettingsBuilder
     .predictSettings()
     .setRetrySettings(
         predictionServiceSettingsBuilder
             .predictSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PredictionServiceStubSettings predictionServiceSettings =
     predictionServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > PredictionServiceStubSettings

Static Methods

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static PredictionServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
PredictionServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static PredictionServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
PredictionServiceStubSettings.Builder

Constructors

PredictionServiceStubSettings(PredictionServiceStubSettings.Builder settingsBuilder)

protected PredictionServiceStubSettings(PredictionServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderPredictionServiceStubSettings.Builder

Methods

countTokensSettings()

public UnaryCallSettings<CountTokensRequest,CountTokensResponse> countTokensSettings()

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

Returns
TypeDescription
UnaryCallSettings<CountTokensRequest,CountTokensResponse>

createStub()

public PredictionServiceStub createStub()
Returns
TypeDescription
PredictionServiceStub
Exceptions
TypeDescription
IOException

directPredictSettings()

public UnaryCallSettings<DirectPredictRequest,DirectPredictResponse> directPredictSettings()

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

Returns
TypeDescription
UnaryCallSettings<DirectPredictRequest,DirectPredictResponse>

directRawPredictSettings()

public UnaryCallSettings<DirectRawPredictRequest,DirectRawPredictResponse> directRawPredictSettings()

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

Returns
TypeDescription
UnaryCallSettings<DirectRawPredictRequest,DirectRawPredictResponse>

explainSettings()

public UnaryCallSettings<ExplainRequest,ExplainResponse> explainSettings()

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

Returns
TypeDescription
UnaryCallSettings<ExplainRequest,ExplainResponse>

generateContentSettings()

public UnaryCallSettings<GenerateContentRequest,GenerateContentResponse> generateContentSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateContentRequest,GenerateContentResponse>

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
TypeDescription
String
Overrides

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>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
TypeDescription
String
Overrides

listLocationsSettings()

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

predictSettings()

public UnaryCallSettings<PredictRequest,PredictResponse> predictSettings()

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

Returns
TypeDescription
UnaryCallSettings<PredictRequest,PredictResponse>

rawPredictSettings()

public UnaryCallSettings<RawPredictRequest,HttpBody> rawPredictSettings()

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

Returns
TypeDescription
UnaryCallSettings<RawPredictRequest,com.google.api.HttpBody>

serverStreamingPredictSettings()

public ServerStreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse> serverStreamingPredictSettings()

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

Returns
TypeDescription
ServerStreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse>

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>

streamDirectPredictSettings()

public StreamingCallSettings<StreamDirectPredictRequest,StreamDirectPredictResponse> streamDirectPredictSettings()

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

Returns
TypeDescription
StreamingCallSettings<StreamDirectPredictRequest,StreamDirectPredictResponse>

streamDirectRawPredictSettings()

public StreamingCallSettings<StreamDirectRawPredictRequest,StreamDirectRawPredictResponse> streamDirectRawPredictSettings()

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

Returns
TypeDescription
StreamingCallSettings<StreamDirectRawPredictRequest,StreamDirectRawPredictResponse>

streamGenerateContentSettings()

public ServerStreamingCallSettings<GenerateContentRequest,GenerateContentResponse> streamGenerateContentSettings()

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

Returns
TypeDescription
ServerStreamingCallSettings<GenerateContentRequest,GenerateContentResponse>

streamingPredictSettings()

public StreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse> streamingPredictSettings()

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

Returns
TypeDescription
StreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse>

streamingRawPredictSettings()

public StreamingCallSettings<StreamingRawPredictRequest,StreamingRawPredictResponse> streamingRawPredictSettings()

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

Returns
TypeDescription
StreamingCallSettings<StreamingRawPredictRequest,StreamingRawPredictResponse>

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 PredictionServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
PredictionServiceStubSettings.Builder
Overrides