Class ApiGatewayServiceStubSettings
- java.lang.Object
-
- com.google.api.gax.rpc.StubSettings<ApiGatewayServiceStubSettings>
-
- com.google.cloud.apigateway.v1.stub.ApiGatewayServiceStubSettings
-
@Generated("by gapic-generator-java") public class ApiGatewayServiceStubSettings extends com.google.api.gax.rpc.StubSettings<ApiGatewayServiceStubSettings>
Settings class to configure an instance ofApiGatewayServiceStub
.The default instance has everything set to sensible defaults:
- The default service address (apigateway.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 getGateway 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 ApiGatewayServiceStubSettings.Builder apiGatewayServiceSettingsBuilder = ApiGatewayServiceStubSettings.newBuilder(); apiGatewayServiceSettingsBuilder .getGatewaySettings() .setRetrySettings( apiGatewayServiceSettingsBuilder .getGatewaySettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); ApiGatewayServiceStubSettings apiGatewayServiceSettings = apiGatewayServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ApiGatewayServiceStubSettings.Builder
Builder for ApiGatewayServiceStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
ApiGatewayServiceStubSettings(ApiGatewayServiceStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.OperationCallSettings<CreateApiConfigRequest,ApiConfig,OperationMetadata>
createApiConfigOperationSettings()
Returns the object with the settings used for calls to createApiConfig.com.google.api.gax.rpc.UnaryCallSettings<CreateApiConfigRequest,com.google.longrunning.Operation>
createApiConfigSettings()
Returns the object with the settings used for calls to createApiConfig.com.google.api.gax.rpc.OperationCallSettings<CreateApiRequest,Api,OperationMetadata>
createApiOperationSettings()
Returns the object with the settings used for calls to createApi.com.google.api.gax.rpc.UnaryCallSettings<CreateApiRequest,com.google.longrunning.Operation>
createApiSettings()
Returns the object with the settings used for calls to createApi.com.google.api.gax.rpc.OperationCallSettings<CreateGatewayRequest,Gateway,OperationMetadata>
createGatewayOperationSettings()
Returns the object with the settings used for calls to createGateway.com.google.api.gax.rpc.UnaryCallSettings<CreateGatewayRequest,com.google.longrunning.Operation>
createGatewaySettings()
Returns the object with the settings used for calls to createGateway.ApiGatewayServiceStub
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.rpc.ApiClientHeaderProvider.Builder
defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteApiConfigRequest,com.google.protobuf.Empty,OperationMetadata>
deleteApiConfigOperationSettings()
Returns the object with the settings used for calls to deleteApiConfig.com.google.api.gax.rpc.UnaryCallSettings<DeleteApiConfigRequest,com.google.longrunning.Operation>
deleteApiConfigSettings()
Returns the object with the settings used for calls to deleteApiConfig.com.google.api.gax.rpc.OperationCallSettings<DeleteApiRequest,com.google.protobuf.Empty,OperationMetadata>
deleteApiOperationSettings()
Returns the object with the settings used for calls to deleteApi.com.google.api.gax.rpc.UnaryCallSettings<DeleteApiRequest,com.google.longrunning.Operation>
deleteApiSettings()
Returns the object with the settings used for calls to deleteApi.com.google.api.gax.rpc.OperationCallSettings<DeleteGatewayRequest,com.google.protobuf.Empty,OperationMetadata>
deleteGatewayOperationSettings()
Returns the object with the settings used for calls to deleteGateway.com.google.api.gax.rpc.UnaryCallSettings<DeleteGatewayRequest,com.google.longrunning.Operation>
deleteGatewaySettings()
Returns the object with the settings used for calls to deleteGateway.com.google.api.gax.rpc.UnaryCallSettings<GetApiConfigRequest,ApiConfig>
getApiConfigSettings()
Returns the object with the settings used for calls to getApiConfig.com.google.api.gax.rpc.UnaryCallSettings<GetApiRequest,Api>
getApiSettings()
Returns the object with the settings used for calls to getApi.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<GetGatewayRequest,Gateway>
getGatewaySettings()
Returns the object with the settings used for calls to getGateway.com.google.api.gax.rpc.PagedCallSettings<ListApiConfigsRequest,ListApiConfigsResponse,ApiGatewayServiceClient.ListApiConfigsPagedResponse>
listApiConfigsSettings()
Returns the object with the settings used for calls to listApiConfigs.com.google.api.gax.rpc.PagedCallSettings<ListApisRequest,ListApisResponse,ApiGatewayServiceClient.ListApisPagedResponse>
listApisSettings()
Returns the object with the settings used for calls to listApis.com.google.api.gax.rpc.PagedCallSettings<ListGatewaysRequest,ListGatewaysResponse,ApiGatewayServiceClient.ListGatewaysPagedResponse>
listGatewaysSettings()
Returns the object with the settings used for calls to listGateways.static ApiGatewayServiceStubSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static ApiGatewayServiceStubSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static ApiGatewayServiceStubSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.ApiGatewayServiceStubSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.OperationCallSettings<UpdateApiConfigRequest,ApiConfig,OperationMetadata>
updateApiConfigOperationSettings()
Returns the object with the settings used for calls to updateApiConfig.com.google.api.gax.rpc.UnaryCallSettings<UpdateApiConfigRequest,com.google.longrunning.Operation>
updateApiConfigSettings()
Returns the object with the settings used for calls to updateApiConfig.com.google.api.gax.rpc.OperationCallSettings<UpdateApiRequest,Api,OperationMetadata>
updateApiOperationSettings()
Returns the object with the settings used for calls to updateApi.com.google.api.gax.rpc.UnaryCallSettings<UpdateApiRequest,com.google.longrunning.Operation>
updateApiSettings()
Returns the object with the settings used for calls to updateApi.com.google.api.gax.rpc.OperationCallSettings<UpdateGatewayRequest,Gateway,OperationMetadata>
updateGatewayOperationSettings()
Returns the object with the settings used for calls to updateGateway.com.google.api.gax.rpc.UnaryCallSettings<UpdateGatewayRequest,com.google.longrunning.Operation>
updateGatewaySettings()
Returns the object with the settings used for calls to updateGateway.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
-
-
-
Constructor Detail
-
ApiGatewayServiceStubSettings
protected ApiGatewayServiceStubSettings(ApiGatewayServiceStubSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listGatewaysSettings
public com.google.api.gax.rpc.PagedCallSettings<ListGatewaysRequest,ListGatewaysResponse,ApiGatewayServiceClient.ListGatewaysPagedResponse> listGatewaysSettings()
Returns the object with the settings used for calls to listGateways.
-
getGatewaySettings
public com.google.api.gax.rpc.UnaryCallSettings<GetGatewayRequest,Gateway> getGatewaySettings()
Returns the object with the settings used for calls to getGateway.
-
createGatewaySettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateGatewayRequest,com.google.longrunning.Operation> createGatewaySettings()
Returns the object with the settings used for calls to createGateway.
-
createGatewayOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateGatewayRequest,Gateway,OperationMetadata> createGatewayOperationSettings()
Returns the object with the settings used for calls to createGateway.
-
updateGatewaySettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateGatewayRequest,com.google.longrunning.Operation> updateGatewaySettings()
Returns the object with the settings used for calls to updateGateway.
-
updateGatewayOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UpdateGatewayRequest,Gateway,OperationMetadata> updateGatewayOperationSettings()
Returns the object with the settings used for calls to updateGateway.
-
deleteGatewaySettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteGatewayRequest,com.google.longrunning.Operation> deleteGatewaySettings()
Returns the object with the settings used for calls to deleteGateway.
-
deleteGatewayOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteGatewayRequest,com.google.protobuf.Empty,OperationMetadata> deleteGatewayOperationSettings()
Returns the object with the settings used for calls to deleteGateway.
-
listApisSettings
public com.google.api.gax.rpc.PagedCallSettings<ListApisRequest,ListApisResponse,ApiGatewayServiceClient.ListApisPagedResponse> listApisSettings()
Returns the object with the settings used for calls to listApis.
-
getApiSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetApiRequest,Api> getApiSettings()
Returns the object with the settings used for calls to getApi.
-
createApiSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateApiRequest,com.google.longrunning.Operation> createApiSettings()
Returns the object with the settings used for calls to createApi.
-
createApiOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateApiRequest,Api,OperationMetadata> createApiOperationSettings()
Returns the object with the settings used for calls to createApi.
-
updateApiSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateApiRequest,com.google.longrunning.Operation> updateApiSettings()
Returns the object with the settings used for calls to updateApi.
-
updateApiOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UpdateApiRequest,Api,OperationMetadata> updateApiOperationSettings()
Returns the object with the settings used for calls to updateApi.
-
deleteApiSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteApiRequest,com.google.longrunning.Operation> deleteApiSettings()
Returns the object with the settings used for calls to deleteApi.
-
deleteApiOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteApiRequest,com.google.protobuf.Empty,OperationMetadata> deleteApiOperationSettings()
Returns the object with the settings used for calls to deleteApi.
-
listApiConfigsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListApiConfigsRequest,ListApiConfigsResponse,ApiGatewayServiceClient.ListApiConfigsPagedResponse> listApiConfigsSettings()
Returns the object with the settings used for calls to listApiConfigs.
-
getApiConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetApiConfigRequest,ApiConfig> getApiConfigSettings()
Returns the object with the settings used for calls to getApiConfig.
-
createApiConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateApiConfigRequest,com.google.longrunning.Operation> createApiConfigSettings()
Returns the object with the settings used for calls to createApiConfig.
-
createApiConfigOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateApiConfigRequest,ApiConfig,OperationMetadata> createApiConfigOperationSettings()
Returns the object with the settings used for calls to createApiConfig.
-
updateApiConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateApiConfigRequest,com.google.longrunning.Operation> updateApiConfigSettings()
Returns the object with the settings used for calls to updateApiConfig.
-
updateApiConfigOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UpdateApiConfigRequest,ApiConfig,OperationMetadata> updateApiConfigOperationSettings()
Returns the object with the settings used for calls to updateApiConfig.
-
deleteApiConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteApiConfigRequest,com.google.longrunning.Operation> deleteApiConfigSettings()
Returns the object with the settings used for calls to deleteApiConfig.
-
deleteApiConfigOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteApiConfigRequest,com.google.protobuf.Empty,OperationMetadata> deleteApiConfigOperationSettings()
Returns the object with the settings used for calls to deleteApiConfig.
-
createStub
public ApiGatewayServiceStub createStub() throws IOException
- Throws:
IOException
-
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 gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultGrpcApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
-
defaultHttpJsonApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
-
defaultApiClientHeaderProviderBuilder
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static ApiGatewayServiceStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
public static ApiGatewayServiceStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static ApiGatewayServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public ApiGatewayServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.StubSettings<ApiGatewayServiceStubSettings>
-
-