com.google.cloud.aiplatform.v1.stub

Class PredictionServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<PredictionServiceStubSettings>

com.google.cloud.aiplatform.v1.stub.PredictionServiceStubSettings

@Generated(value="by gapic-generator-java")
public class PredictionServiceStubSettings
extends com.google.api.gax.rpc.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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredictionServiceStubSettings.Builder Builder for PredictionServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PredictionServiceStubSettings(PredictionServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
PredictionServiceStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DirectPredictRequest,DirectPredictResponse>	directPredictSettings() Returns the object with the settings used for calls to directPredict.
com.google.api.gax.rpc.UnaryCallSettings<DirectRawPredictRequest,DirectRawPredictResponse>	directRawPredictSettings() Returns the object with the settings used for calls to directRawPredict.
com.google.api.gax.rpc.UnaryCallSettings<ExplainRequest,ExplainResponse>	explainSettings() Returns the object with the settings used for calls to explain.
com.google.api.gax.rpc.UnaryCallSettings<GenerateContentRequest,GenerateContentResponse>	generateContentSettings() Returns the object with the settings used for calls to generateContent.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,PredictionServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static PredictionServiceStubSettings.Builder	newBuilder() Returns a new builder for this class.
static PredictionServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<PredictRequest,PredictResponse>	predictSettings() Returns the object with the settings used for calls to predict.
com.google.api.gax.rpc.UnaryCallSettings<RawPredictRequest,com.google.api.HttpBody>	rawPredictSettings() Returns the object with the settings used for calls to rawPredict.
com.google.api.gax.rpc.ServerStreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse>	serverStreamingPredictSettings() Returns the object with the settings used for calls to serverStreamingPredict.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.StreamingCallSettings<StreamDirectPredictRequest,StreamDirectPredictResponse>	streamDirectPredictSettings() Returns the object with the settings used for calls to streamDirectPredict.
com.google.api.gax.rpc.StreamingCallSettings<StreamDirectRawPredictRequest,StreamDirectRawPredictResponse>	streamDirectRawPredictSettings() Returns the object with the settings used for calls to streamDirectRawPredict.
com.google.api.gax.rpc.ServerStreamingCallSettings<GenerateContentRequest,GenerateContentResponse>	streamGenerateContentSettings() Returns the object with the settings used for calls to streamGenerateContent.
com.google.api.gax.rpc.StreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse>	streamingPredictSettings() Returns the object with the settings used for calls to streamingPredict.
com.google.api.gax.rpc.StreamingCallSettings<StreamingRawPredictRequest,StreamingRawPredictResponse>	streamingRawPredictSettings() Returns the object with the settings used for calls to streamingRawPredict.
com.google.api.gax.rpc.ServerStreamingCallSettings<StreamRawPredictRequest,com.google.api.HttpBody>	streamRawPredictSettings() Returns the object with the settings used for calls to streamRawPredict.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
PredictionServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PredictionServiceStubSettings

protected PredictionServiceStubSettings(PredictionServiceStubSettings.Builder settingsBuilder)
                                 throws IOException

Throws:

IOException

Method Detail

predictSettings

public com.google.api.gax.rpc.UnaryCallSettings<PredictRequest,PredictResponse> predictSettings()

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

rawPredictSettings

public com.google.api.gax.rpc.UnaryCallSettings<RawPredictRequest,com.google.api.HttpBody> rawPredictSettings()

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

streamRawPredictSettings

public com.google.api.gax.rpc.ServerStreamingCallSettings<StreamRawPredictRequest,com.google.api.HttpBody> streamRawPredictSettings()

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

directPredictSettings

public com.google.api.gax.rpc.UnaryCallSettings<DirectPredictRequest,DirectPredictResponse> directPredictSettings()

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

directRawPredictSettings

public com.google.api.gax.rpc.UnaryCallSettings<DirectRawPredictRequest,DirectRawPredictResponse> directRawPredictSettings()

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

streamDirectPredictSettings

public com.google.api.gax.rpc.StreamingCallSettings<StreamDirectPredictRequest,StreamDirectPredictResponse> streamDirectPredictSettings()

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

streamDirectRawPredictSettings

public com.google.api.gax.rpc.StreamingCallSettings<StreamDirectRawPredictRequest,StreamDirectRawPredictResponse> streamDirectRawPredictSettings()

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

streamingPredictSettings

public com.google.api.gax.rpc.StreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse> streamingPredictSettings()

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

serverStreamingPredictSettings

public com.google.api.gax.rpc.ServerStreamingCallSettings<StreamingPredictRequest,StreamingPredictResponse> serverStreamingPredictSettings()

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

streamingRawPredictSettings

public com.google.api.gax.rpc.StreamingCallSettings<StreamingRawPredictRequest,StreamingRawPredictResponse> streamingRawPredictSettings()

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

explainSettings

public com.google.api.gax.rpc.UnaryCallSettings<ExplainRequest,ExplainResponse> explainSettings()

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

generateContentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateContentRequest,GenerateContentResponse> generateContentSettings()

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

streamGenerateContentSettings

public com.google.api.gax.rpc.ServerStreamingCallSettings<GenerateContentRequest,GenerateContentResponse> streamGenerateContentSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,PredictionServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

createStub

public PredictionServiceStub createStub()
                                 throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<PredictionServiceStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static PredictionServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static PredictionServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public PredictionServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<PredictionServiceStubSettings>