public class PartnerServiceStubSettings extends StubSettings<PartnerServiceStubSettings>Settings class to configure an instance of PartnerServiceStub.
The default instance has everything set to sensible defaults:
- The default service address (admanager.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 RetrySettings of getPartner:
// 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
PartnerServiceStubSettings.Builder partnerServiceSettingsBuilder =
PartnerServiceStubSettings.newBuilder();
partnerServiceSettingsBuilder
.getPartnerSettings()
.setRetrySettings(
partnerServiceSettingsBuilder
.getPartnerSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
PartnerServiceStubSettings partnerServiceSettings = partnerServiceSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
Static Methods
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider |
|
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static PartnerServiceStubSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
PartnerServiceStubSettings.Builder |
|
newBuilder(@Nullable ClientContext clientContext)
public static PartnerServiceStubSettings.Builder newBuilder(@Nullable ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ClientContext |
| Returns | |
|---|---|
| Type | Description |
PartnerServiceStubSettings.Builder |
|
Constructors
PartnerServiceStubSettings(PartnerServiceStubSettings.Builder settingsBuilder)
protected PartnerServiceStubSettings(PartnerServiceStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
PartnerServiceStubSettings.Builder |
Methods
batchUpdatePartnersSettings()
public UnaryCallSettings<BatchUpdatePartnersRequest,BatchUpdatePartnersResponse> batchUpdatePartnersSettings()Returns the object with the settings used for calls to batchUpdatePartners.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<BatchUpdatePartnersRequest,BatchUpdatePartnersResponse> |
|
createStub()
public PartnerServiceStub createStub()| Returns | |
|---|---|
| Type | Description |
PartnerServiceStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
getLibraryMetadata()
protected LibraryMetadata getLibraryMetadata()| Returns | |
|---|---|
| Type | Description |
LibraryMetadata |
|
getPartnerSettings()
public UnaryCallSettings<GetPartnerRequest,Partner> getPartnerSettings()Returns the object with the settings used for calls to getPartner.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetPartnerRequest,Partner> |
|
getServiceName()
public String getServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
listPartnersSettings()
public PagedCallSettings<ListPartnersRequest,ListPartnersResponse,PartnerServiceClient.ListPartnersPagedResponse> listPartnersSettings()Returns the object with the settings used for calls to listPartners.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListPartnersRequest,ListPartnersResponse,ListPartnersPagedResponse> |
|
toBuilder()
public PartnerServiceStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
PartnerServiceStubSettings.Builder |
|
updatePartnerSettings()
public UnaryCallSettings<UpdatePartnerRequest,Partner> updatePartnerSettings()Returns the object with the settings used for calls to updatePartner.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdatePartnerRequest,Partner> |
|