Class EdgeNetworkStubSettings (0.21.0) 

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 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 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)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 edgeNetworkSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > EdgeNetworkStubSettings

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 EdgeNetworkStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
EdgeNetworkStubSettings.Builder

newBuilder(ClientContext clientContext)

public static EdgeNetworkStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
EdgeNetworkStubSettings.Builder

newHttpJsonBuilder()

public static EdgeNetworkStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
EdgeNetworkStubSettings.Builder

Constructors

EdgeNetworkStubSettings(EdgeNetworkStubSettings.Builder settingsBuilder)

protected EdgeNetworkStubSettings(EdgeNetworkStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder EdgeNetworkStubSettings.Builder

Methods

createInterconnectAttachmentOperationSettings()

public OperationCallSettings<CreateInterconnectAttachmentRequest,InterconnectAttachment,OperationMetadata> createInterconnectAttachmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateInterconnectAttachmentRequest,InterconnectAttachment,OperationMetadata>

createInterconnectAttachmentSettings()

public UnaryCallSettings<CreateInterconnectAttachmentRequest,Operation> createInterconnectAttachmentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateInterconnectAttachmentRequest,Operation>

createNetworkOperationSettings()

public OperationCallSettings<CreateNetworkRequest,Network,OperationMetadata> createNetworkOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateNetworkRequest,Network,OperationMetadata>

createNetworkSettings()

public UnaryCallSettings<CreateNetworkRequest,Operation> createNetworkSettings()

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

Returns
Type Description
UnaryCallSettings<CreateNetworkRequest,Operation>

createRouterOperationSettings()

public OperationCallSettings<CreateRouterRequest,Router,OperationMetadata> createRouterOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateRouterRequest,Router,OperationMetadata>

createRouterSettings()

public UnaryCallSettings<CreateRouterRequest,Operation> createRouterSettings()

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

Returns
Type Description
UnaryCallSettings<CreateRouterRequest,Operation>

createStub()

public EdgeNetworkStub createStub()
Returns
Type Description
EdgeNetworkStub
Exceptions
Type Description
IOException

createSubnetOperationSettings()

public OperationCallSettings<CreateSubnetRequest,Subnet,OperationMetadata> createSubnetOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateSubnetRequest,Subnet,OperationMetadata>

createSubnetSettings()

public UnaryCallSettings<CreateSubnetRequest,Operation> createSubnetSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSubnetRequest,Operation>

deleteInterconnectAttachmentOperationSettings()

public OperationCallSettings<DeleteInterconnectAttachmentRequest,Empty,OperationMetadata> deleteInterconnectAttachmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteInterconnectAttachmentRequest,Empty,OperationMetadata>

deleteInterconnectAttachmentSettings()

public UnaryCallSettings<DeleteInterconnectAttachmentRequest,Operation> deleteInterconnectAttachmentSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteInterconnectAttachmentRequest,Operation>

deleteNetworkOperationSettings()

public OperationCallSettings<DeleteNetworkRequest,Empty,OperationMetadata> deleteNetworkOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteNetworkRequest,Empty,OperationMetadata>

deleteNetworkSettings()

public UnaryCallSettings<DeleteNetworkRequest,Operation> deleteNetworkSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteNetworkRequest,Operation>

deleteRouterOperationSettings()

public OperationCallSettings<DeleteRouterRequest,Empty,OperationMetadata> deleteRouterOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteRouterRequest,Empty,OperationMetadata>

deleteRouterSettings()

public UnaryCallSettings<DeleteRouterRequest,Operation> deleteRouterSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteRouterRequest,Operation>

deleteSubnetOperationSettings()

public OperationCallSettings<DeleteSubnetRequest,Empty,OperationMetadata> deleteSubnetOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteSubnetRequest,Empty,OperationMetadata>

deleteSubnetSettings()

public UnaryCallSettings<DeleteSubnetRequest,Operation> deleteSubnetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteSubnetRequest,Operation>

diagnoseInterconnectSettings()

public UnaryCallSettings<DiagnoseInterconnectRequest,DiagnoseInterconnectResponse> diagnoseInterconnectSettings()

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

Returns
Type Description
UnaryCallSettings<DiagnoseInterconnectRequest,DiagnoseInterconnectResponse>

diagnoseNetworkSettings()

public UnaryCallSettings<DiagnoseNetworkRequest,DiagnoseNetworkResponse> diagnoseNetworkSettings()

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

Returns
Type Description
UnaryCallSettings<DiagnoseNetworkRequest,DiagnoseNetworkResponse>

diagnoseRouterSettings()

public UnaryCallSettings<DiagnoseRouterRequest,DiagnoseRouterResponse> diagnoseRouterSettings()

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

Returns
Type Description
UnaryCallSettings<DiagnoseRouterRequest,DiagnoseRouterResponse>

getInterconnectAttachmentSettings()

public UnaryCallSettings<GetInterconnectAttachmentRequest,InterconnectAttachment> getInterconnectAttachmentSettings()

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

Returns
Type Description
UnaryCallSettings<GetInterconnectAttachmentRequest,InterconnectAttachment>

getInterconnectSettings()

public UnaryCallSettings<GetInterconnectRequest,Interconnect> getInterconnectSettings()

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

Returns
Type Description
UnaryCallSettings<GetInterconnectRequest,Interconnect>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getNetworkSettings()

public UnaryCallSettings<GetNetworkRequest,Network> getNetworkSettings()

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

Returns
Type Description
UnaryCallSettings<GetNetworkRequest,Network>

getRouterSettings()

public UnaryCallSettings<GetRouterRequest,Router> getRouterSettings()

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

Returns
Type Description
UnaryCallSettings<GetRouterRequest,Router>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getSubnetSettings()

public UnaryCallSettings<GetSubnetRequest,Subnet> getSubnetSettings()

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

Returns
Type Description
UnaryCallSettings<GetSubnetRequest,Subnet>

getZoneSettings() (deprecated)

public UnaryCallSettings<GetZoneRequest,Zone> 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.

Returns
Type Description
UnaryCallSettings<GetZoneRequest,Zone>

initializeZoneSettings()

public UnaryCallSettings<InitializeZoneRequest,InitializeZoneResponse> initializeZoneSettings()

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

Returns
Type Description
UnaryCallSettings<InitializeZoneRequest,InitializeZoneResponse>

listInterconnectAttachmentsSettings()

public PagedCallSettings<ListInterconnectAttachmentsRequest,ListInterconnectAttachmentsResponse,EdgeNetworkClient.ListInterconnectAttachmentsPagedResponse> listInterconnectAttachmentsSettings()

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

Returns
Type Description
PagedCallSettings<ListInterconnectAttachmentsRequest,ListInterconnectAttachmentsResponse,ListInterconnectAttachmentsPagedResponse>

listInterconnectsSettings()

public PagedCallSettings<ListInterconnectsRequest,ListInterconnectsResponse,EdgeNetworkClient.ListInterconnectsPagedResponse> listInterconnectsSettings()

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

Returns
Type Description
PagedCallSettings<ListInterconnectsRequest,ListInterconnectsResponse,ListInterconnectsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,EdgeNetworkClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listNetworksSettings()

public PagedCallSettings<ListNetworksRequest,ListNetworksResponse,EdgeNetworkClient.ListNetworksPagedResponse> listNetworksSettings()

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

Returns
Type Description
PagedCallSettings<ListNetworksRequest,ListNetworksResponse,ListNetworksPagedResponse>

listRoutersSettings()

public PagedCallSettings<ListRoutersRequest,ListRoutersResponse,EdgeNetworkClient.ListRoutersPagedResponse> listRoutersSettings()

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

Returns
Type Description
PagedCallSettings<ListRoutersRequest,ListRoutersResponse,ListRoutersPagedResponse>

listSubnetsSettings()

public PagedCallSettings<ListSubnetsRequest,ListSubnetsResponse,EdgeNetworkClient.ListSubnetsPagedResponse> listSubnetsSettings()

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

Returns
Type Description
PagedCallSettings<ListSubnetsRequest,ListSubnetsResponse,ListSubnetsPagedResponse>

listZonesSettings() (deprecated)

public PagedCallSettings<ListZonesRequest,ListZonesResponse,EdgeNetworkClient.ListZonesPagedResponse> listZonesSettings()

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.

Returns
Type Description
PagedCallSettings<ListZonesRequest,ListZonesResponse,ListZonesPagedResponse>

toBuilder()

public EdgeNetworkStubSettings.Builder toBuilder()

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

Returns
Type Description
EdgeNetworkStubSettings.Builder
Overrides

updateRouterOperationSettings()

public OperationCallSettings<UpdateRouterRequest,Router,OperationMetadata> updateRouterOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateRouterRequest,Router,OperationMetadata>

updateRouterSettings()

public UnaryCallSettings<UpdateRouterRequest,Operation> updateRouterSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateRouterRequest,Operation>

updateSubnetOperationSettings()

public OperationCallSettings<UpdateSubnetRequest,Subnet,OperationMetadata> updateSubnetOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateSubnetRequest,Subnet,OperationMetadata>

updateSubnetSettings()

public UnaryCallSettings<UpdateSubnetRequest,Operation> updateSubnetSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateSubnetRequest,Operation>