Class EdgeNetworkStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<EdgeNetworkStubSettings>
com.google.cloud.edgenetwork.v1.stub.EdgeNetworkStubSettings
@Generated("by gapic-generator-java")
public class EdgeNetworkStubSettings
extends StubSettings<EdgeNetworkStubSettings>
Settings class to configure an instance of
EdgeNetworkStub.
The default instance has everything set to sensible defaults:
- The default service address (edgenetwork.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of initializeZone:
// 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
EdgeNetworkStubSettings.Builder edgeNetworkSettingsBuilder =
EdgeNetworkStubSettings.newBuilder();
edgeNetworkSettingsBuilder
.initializeZoneSettings()
.setRetrySettings(
edgeNetworkSettingsBuilder
.initializeZoneSettings()
.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());
EdgeNetworkStubSettings edgeNetworkSettings = edgeNetworkSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createNetwork:
// 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
EdgeNetworkStubSettings.Builder edgeNetworkSettingsBuilder =
EdgeNetworkStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
edgeNetworkSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for EdgeNetworkStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEdgeNetworkStubSettings(EdgeNetworkStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createInterconnectAttachment.Returns the object with the settings used for calls to createInterconnectAttachment.Returns the object with the settings used for calls to createNetwork.Returns the object with the settings used for calls to createNetwork.Returns the object with the settings used for calls to createRouter.Returns the object with the settings used for calls to createRouter.Returns the object with the settings used for calls to createSubnet.Returns the object with the settings used for calls to createSubnet.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteInterconnectAttachmentRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteInterconnectAttachment.Returns the object with the settings used for calls to deleteInterconnectAttachment.OperationCallSettings<DeleteNetworkRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteNetwork.Returns the object with the settings used for calls to deleteNetwork.OperationCallSettings<DeleteRouterRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteRouter.Returns the object with the settings used for calls to deleteRouter.OperationCallSettings<DeleteSubnetRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteSubnet.Returns the object with the settings used for calls to deleteSubnet.Returns the object with the settings used for calls to diagnoseInterconnect.Returns the object with the settings used for calls to diagnoseNetwork.Returns the object with the settings used for calls to diagnoseRouter.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getInterconnectAttachment.Returns the object with the settings used for calls to getInterconnect.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getNetwork.Returns the object with the settings used for calls to getRouter.Returns the default service name.Returns the object with the settings used for calls to getSubnet.Deprecated.This method is deprecated and will be removed in the next major version update.Returns the object with the settings used for calls to initializeZone.PagedCallSettings<ListInterconnectAttachmentsRequest,ListInterconnectAttachmentsResponse, EdgeNetworkClient.ListInterconnectAttachmentsPagedResponse> Returns the object with the settings used for calls to listInterconnectAttachments.PagedCallSettings<ListInterconnectsRequest,ListInterconnectsResponse, EdgeNetworkClient.ListInterconnectsPagedResponse> Returns the object with the settings used for calls to listInterconnects.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, EdgeNetworkClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListNetworksRequest,ListNetworksResponse, EdgeNetworkClient.ListNetworksPagedResponse> Returns the object with the settings used for calls to listNetworks.PagedCallSettings<ListRoutersRequest,ListRoutersResponse, EdgeNetworkClient.ListRoutersPagedResponse> Returns the object with the settings used for calls to listRouters.PagedCallSettings<ListSubnetsRequest,ListSubnetsResponse, EdgeNetworkClient.ListSubnetsPagedResponse> Returns the object with the settings used for calls to listSubnets.Deprecated.This method is deprecated and will be removed in the next major version update.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateRouter.Returns the object with the settings used for calls to updateRouter.Returns the object with the settings used for calls to updateSubnet.Returns the object with the settings used for calls to updateSubnet.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
EdgeNetworkStubSettings
protected EdgeNetworkStubSettings(EdgeNetworkStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
initializeZoneSettings
Returns the object with the settings used for calls to initializeZone. -
listZonesSettings
@Deprecated public PagedCallSettings<ListZonesRequest,ListZonesResponse, listZonesSettings()EdgeNetworkClient.ListZonesPagedResponse> Deprecated.This method is deprecated and will be removed in the next major version update.Returns the object with the settings used for calls to listZones. -
getZoneSettings
Deprecated.This method is deprecated and will be removed in the next major version update.Returns the object with the settings used for calls to getZone. -
listNetworksSettings
public PagedCallSettings<ListNetworksRequest,ListNetworksResponse, listNetworksSettings()EdgeNetworkClient.ListNetworksPagedResponse> Returns the object with the settings used for calls to listNetworks. -
getNetworkSettings
Returns the object with the settings used for calls to getNetwork. -
diagnoseNetworkSettings
Returns the object with the settings used for calls to diagnoseNetwork. -
createNetworkSettings
Returns the object with the settings used for calls to createNetwork. -
createNetworkOperationSettings
public OperationCallSettings<CreateNetworkRequest,Network, createNetworkOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createNetwork. -
deleteNetworkSettings
Returns the object with the settings used for calls to deleteNetwork. -
deleteNetworkOperationSettings
public OperationCallSettings<DeleteNetworkRequest,com.google.protobuf.Empty, deleteNetworkOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteNetwork. -
listSubnetsSettings
public PagedCallSettings<ListSubnetsRequest,ListSubnetsResponse, listSubnetsSettings()EdgeNetworkClient.ListSubnetsPagedResponse> Returns the object with the settings used for calls to listSubnets. -
getSubnetSettings
Returns the object with the settings used for calls to getSubnet. -
createSubnetSettings
Returns the object with the settings used for calls to createSubnet. -
createSubnetOperationSettings
public OperationCallSettings<CreateSubnetRequest,Subnet, createSubnetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createSubnet. -
updateSubnetSettings
Returns the object with the settings used for calls to updateSubnet. -
updateSubnetOperationSettings
public OperationCallSettings<UpdateSubnetRequest,Subnet, updateSubnetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateSubnet. -
deleteSubnetSettings
Returns the object with the settings used for calls to deleteSubnet. -
deleteSubnetOperationSettings
public OperationCallSettings<DeleteSubnetRequest,com.google.protobuf.Empty, deleteSubnetOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteSubnet. -
listInterconnectsSettings
public PagedCallSettings<ListInterconnectsRequest,ListInterconnectsResponse, listInterconnectsSettings()EdgeNetworkClient.ListInterconnectsPagedResponse> Returns the object with the settings used for calls to listInterconnects. -
getInterconnectSettings
Returns the object with the settings used for calls to getInterconnect. -
diagnoseInterconnectSettings
public UnaryCallSettings<DiagnoseInterconnectRequest,DiagnoseInterconnectResponse> diagnoseInterconnectSettings()Returns the object with the settings used for calls to diagnoseInterconnect. -
listInterconnectAttachmentsSettings
public PagedCallSettings<ListInterconnectAttachmentsRequest,ListInterconnectAttachmentsResponse, listInterconnectAttachmentsSettings()EdgeNetworkClient.ListInterconnectAttachmentsPagedResponse> Returns the object with the settings used for calls to listInterconnectAttachments. -
getInterconnectAttachmentSettings
public UnaryCallSettings<GetInterconnectAttachmentRequest,InterconnectAttachment> getInterconnectAttachmentSettings()Returns the object with the settings used for calls to getInterconnectAttachment. -
createInterconnectAttachmentSettings
public UnaryCallSettings<CreateInterconnectAttachmentRequest,Operation> createInterconnectAttachmentSettings()Returns the object with the settings used for calls to createInterconnectAttachment. -
createInterconnectAttachmentOperationSettings
public OperationCallSettings<CreateInterconnectAttachmentRequest,InterconnectAttachment, createInterconnectAttachmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createInterconnectAttachment. -
deleteInterconnectAttachmentSettings
public UnaryCallSettings<DeleteInterconnectAttachmentRequest,Operation> deleteInterconnectAttachmentSettings()Returns the object with the settings used for calls to deleteInterconnectAttachment. -
deleteInterconnectAttachmentOperationSettings
public OperationCallSettings<DeleteInterconnectAttachmentRequest,com.google.protobuf.Empty, deleteInterconnectAttachmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteInterconnectAttachment. -
listRoutersSettings
public PagedCallSettings<ListRoutersRequest,ListRoutersResponse, listRoutersSettings()EdgeNetworkClient.ListRoutersPagedResponse> Returns the object with the settings used for calls to listRouters. -
getRouterSettings
Returns the object with the settings used for calls to getRouter. -
diagnoseRouterSettings
Returns the object with the settings used for calls to diagnoseRouter. -
createRouterSettings
Returns the object with the settings used for calls to createRouter. -
createRouterOperationSettings
public OperationCallSettings<CreateRouterRequest,Router, createRouterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createRouter. -
updateRouterSettings
Returns the object with the settings used for calls to updateRouter. -
updateRouterOperationSettings
public OperationCallSettings<UpdateRouterRequest,Router, updateRouterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateRouter. -
deleteRouterSettings
Returns the object with the settings used for calls to deleteRouter. -
deleteRouterOperationSettings
public OperationCallSettings<DeleteRouterRequest,com.google.protobuf.Empty, deleteRouterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteRouter. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()EdgeNetworkClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<EdgeNetworkStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<EdgeNetworkStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<EdgeNetworkStubSettings>
-