Package com.google.cloud.compute.v1
Class InstanceGroupsSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<InstanceGroupsSettings>
-
- com.google.cloud.compute.v1.InstanceGroupsSettings
-
@Generated("by gapic-generator-java") public class InstanceGroupsSettings extends com.google.api.gax.rpc.ClientSettings<InstanceGroupsSettings>
Settings class to configure an instance ofInstanceGroupsClient
.The default instance has everything set to sensible defaults:
- The default service address (compute.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 get 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 InstanceGroupsSettings.Builder instanceGroupsSettingsBuilder = InstanceGroupsSettings.newBuilder(); instanceGroupsSettingsBuilder .getSettings() .setRetrySettings( instanceGroupsSettingsBuilder .getSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); InstanceGroupsSettings instanceGroupsSettings = instanceGroupsSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InstanceGroupsSettings.Builder
Builder for InstanceGroupsSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
InstanceGroupsSettings(InstanceGroupsSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.OperationCallSettings<AddInstancesInstanceGroupRequest,Operation,Operation>
addInstancesOperationSettings()
Returns the object with the settings used for calls to addInstances.com.google.api.gax.rpc.UnaryCallSettings<AddInstancesInstanceGroupRequest,Operation>
addInstancesSettings()
Returns the object with the settings used for calls to addInstances.com.google.api.gax.rpc.PagedCallSettings<AggregatedListInstanceGroupsRequest,InstanceGroupAggregatedList,InstanceGroupsClient.AggregatedListPagedResponse>
aggregatedListSettings()
Returns the object with the settings used for calls to aggregatedList.static InstanceGroupsSettings
create(InstanceGroupsStubSettings stub)
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.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteInstanceGroupRequest,Operation,Operation>
deleteOperationSettings()
Returns the object with the settings used for calls to delete.com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceGroupRequest,Operation>
deleteSettings()
Returns the object with the settings used for calls to delete.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<GetInstanceGroupRequest,InstanceGroup>
getSettings()
Returns the object with the settings used for calls to get.com.google.api.gax.rpc.OperationCallSettings<InsertInstanceGroupRequest,Operation,Operation>
insertOperationSettings()
Returns the object with the settings used for calls to insert.com.google.api.gax.rpc.UnaryCallSettings<InsertInstanceGroupRequest,Operation>
insertSettings()
Returns the object with the settings used for calls to insert.com.google.api.gax.rpc.PagedCallSettings<ListInstancesInstanceGroupsRequest,InstanceGroupsListInstances,InstanceGroupsClient.ListInstancesPagedResponse>
listInstancesSettings()
Returns the object with the settings used for calls to listInstances.com.google.api.gax.rpc.PagedCallSettings<ListInstanceGroupsRequest,InstanceGroupList,InstanceGroupsClient.ListPagedResponse>
listSettings()
Returns the object with the settings used for calls to list.static InstanceGroupsSettings.Builder
newBuilder()
Returns a new builder for this class.static InstanceGroupsSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.com.google.api.gax.rpc.OperationCallSettings<RemoveInstancesInstanceGroupRequest,Operation,Operation>
removeInstancesOperationSettings()
Returns the object with the settings used for calls to removeInstances.com.google.api.gax.rpc.UnaryCallSettings<RemoveInstancesInstanceGroupRequest,Operation>
removeInstancesSettings()
Returns the object with the settings used for calls to removeInstances.com.google.api.gax.rpc.OperationCallSettings<SetNamedPortsInstanceGroupRequest,Operation,Operation>
setNamedPortsOperationSettings()
Returns the object with the settings used for calls to setNamedPorts.com.google.api.gax.rpc.UnaryCallSettings<SetNamedPortsInstanceGroupRequest,Operation>
setNamedPortsSettings()
Returns the object with the settings used for calls to setNamedPorts.InstanceGroupsSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
InstanceGroupsSettings
protected InstanceGroupsSettings(InstanceGroupsSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
addInstancesSettings
public com.google.api.gax.rpc.UnaryCallSettings<AddInstancesInstanceGroupRequest,Operation> addInstancesSettings()
Returns the object with the settings used for calls to addInstances.
-
addInstancesOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<AddInstancesInstanceGroupRequest,Operation,Operation> addInstancesOperationSettings()
Returns the object with the settings used for calls to addInstances.
-
aggregatedListSettings
public com.google.api.gax.rpc.PagedCallSettings<AggregatedListInstanceGroupsRequest,InstanceGroupAggregatedList,InstanceGroupsClient.AggregatedListPagedResponse> aggregatedListSettings()
Returns the object with the settings used for calls to aggregatedList.
-
deleteSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceGroupRequest,Operation> deleteSettings()
Returns the object with the settings used for calls to delete.
-
deleteOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteInstanceGroupRequest,Operation,Operation> deleteOperationSettings()
Returns the object with the settings used for calls to delete.
-
getSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceGroupRequest,InstanceGroup> getSettings()
Returns the object with the settings used for calls to get.
-
insertSettings
public com.google.api.gax.rpc.UnaryCallSettings<InsertInstanceGroupRequest,Operation> insertSettings()
Returns the object with the settings used for calls to insert.
-
insertOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<InsertInstanceGroupRequest,Operation,Operation> insertOperationSettings()
Returns the object with the settings used for calls to insert.
-
listSettings
public com.google.api.gax.rpc.PagedCallSettings<ListInstanceGroupsRequest,InstanceGroupList,InstanceGroupsClient.ListPagedResponse> listSettings()
Returns the object with the settings used for calls to list.
-
listInstancesSettings
public com.google.api.gax.rpc.PagedCallSettings<ListInstancesInstanceGroupsRequest,InstanceGroupsListInstances,InstanceGroupsClient.ListInstancesPagedResponse> listInstancesSettings()
Returns the object with the settings used for calls to listInstances.
-
removeInstancesSettings
public com.google.api.gax.rpc.UnaryCallSettings<RemoveInstancesInstanceGroupRequest,Operation> removeInstancesSettings()
Returns the object with the settings used for calls to removeInstances.
-
removeInstancesOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<RemoveInstancesInstanceGroupRequest,Operation,Operation> removeInstancesOperationSettings()
Returns the object with the settings used for calls to removeInstances.
-
setNamedPortsSettings
public com.google.api.gax.rpc.UnaryCallSettings<SetNamedPortsInstanceGroupRequest,Operation> setNamedPortsSettings()
Returns the object with the settings used for calls to setNamedPorts.
-
setNamedPortsOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<SetNamedPortsInstanceGroupRequest,Operation,Operation> setNamedPortsOperationSettings()
Returns the object with the settings used for calls to setNamedPorts.
-
create
public static final InstanceGroupsSettings create(InstanceGroupsStubSettings stub) 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.
-
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.
-
defaultHttpJsonTransportProviderBuilder
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@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 defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static InstanceGroupsSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static InstanceGroupsSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public InstanceGroupsSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<InstanceGroupsSettings>
-
-