Class AutoScalingClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.autoscaling.AutoScalingClient
-
- All Implemented Interfaces:
AutoScaling,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20181001") public class AutoScalingClient extends BaseSyncClient implements AutoScaling
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAutoScalingClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for AutoScaling.
-
Constructor Summary
Constructors Constructor Description AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AutoScalingClient.Builderbuilder()Create a builder for this client.ChangeAutoScalingConfigurationCompartmentResponsechangeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request)Moves an autoscaling configuration into a different compartment within the same tenancy.voidclose()CreateAutoScalingConfigurationResponsecreateAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)Creates an autoscaling configuration.CreateAutoScalingPolicyResponsecreateAutoScalingPolicy(CreateAutoScalingPolicyRequest request)Creates an autoscaling policy for the specified autoscaling configuration.DeleteAutoScalingConfigurationResponsedeleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)Deletes an autoscaling configuration.DeleteAutoScalingPolicyResponsedeleteAutoScalingPolicy(DeleteAutoScalingPolicyRequest request)Deletes an autoscaling policy for the specified autoscaling configuration.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetAutoScalingConfigurationResponsegetAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)Gets information about the specified autoscaling configuration.GetAutoScalingPolicyResponsegetAutoScalingPolicy(GetAutoScalingPolicyRequest request)Gets information about the specified autoscaling policy in the specified autoscaling configuration.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.AutoScalingPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.ListAutoScalingConfigurationsResponselistAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)Lists autoscaling configurations in the specifed compartment.ListAutoScalingPoliciesResponselistAutoScalingPolicies(ListAutoScalingPoliciesRequest request)Lists the autoscaling policies in the specified autoscaling configuration.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateAutoScalingConfigurationResponseupdateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)Updates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.UpdateAutoScalingPolicyResponseupdateAutoScalingPolicy(UpdateAutoScalingPolicyRequest request)Updates an autoscaling policy in the specified autoscaling configuration.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.autoscaling.AutoScaling
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
AutoScalingClient
@Deprecated public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
AutoScalingClient
@Deprecated public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
AutoScalingClient
@Deprecated public AutoScalingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
AutoScalingClient
@Deprecated public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
AutoScalingClient
@Deprecated public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
AutoScalingClient
@Deprecated public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
AutoScalingClient
@Deprecated public AutoScalingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeAutoScalingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static AutoScalingClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:AutoScalingSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceAutoScaling- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:AutoScalingSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
setRegionin interfaceAutoScaling- Parameters:
regionId- The public region ID.
-
changeAutoScalingConfigurationCompartment
public ChangeAutoScalingConfigurationCompartmentResponse changeAutoScalingConfigurationCompartment(ChangeAutoScalingConfigurationCompartmentRequest request)
Description copied from interface:AutoScalingMoves an autoscaling configuration into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When you move an autoscaling configuration to a different compartment, associated resources such as instance pools are not moved.
- Specified by:
changeAutoScalingConfigurationCompartmentin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAutoScalingConfiguration
public CreateAutoScalingConfigurationResponse createAutoScalingConfiguration(CreateAutoScalingConfigurationRequest request)
Description copied from interface:AutoScalingCreates an autoscaling configuration.- Specified by:
createAutoScalingConfigurationin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAutoScalingPolicy
public CreateAutoScalingPolicyResponse createAutoScalingPolicy(CreateAutoScalingPolicyRequest request)
Description copied from interface:AutoScalingCreates an autoscaling policy for the specified autoscaling configuration.You can create the following types of autoscaling policies:
- **Schedule-based:** Autoscaling events take place at the specific times that you schedule. - **Threshold-based:** An autoscaling action is triggered when a performance metric meets or exceeds a threshold.
An autoscaling configuration can either have multiple schedule-based autoscaling policies, or one threshold-based autoscaling policy.
- Specified by:
createAutoScalingPolicyin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAutoScalingConfiguration
public DeleteAutoScalingConfigurationResponse deleteAutoScalingConfiguration(DeleteAutoScalingConfigurationRequest request)
Description copied from interface:AutoScalingDeletes an autoscaling configuration.- Specified by:
deleteAutoScalingConfigurationin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAutoScalingPolicy
public DeleteAutoScalingPolicyResponse deleteAutoScalingPolicy(DeleteAutoScalingPolicyRequest request)
Description copied from interface:AutoScalingDeletes an autoscaling policy for the specified autoscaling configuration.- Specified by:
deleteAutoScalingPolicyin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAutoScalingConfiguration
public GetAutoScalingConfigurationResponse getAutoScalingConfiguration(GetAutoScalingConfigurationRequest request)
Description copied from interface:AutoScalingGets information about the specified autoscaling configuration.- Specified by:
getAutoScalingConfigurationin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAutoScalingPolicy
public GetAutoScalingPolicyResponse getAutoScalingPolicy(GetAutoScalingPolicyRequest request)
Description copied from interface:AutoScalingGets information about the specified autoscaling policy in the specified autoscaling configuration.- Specified by:
getAutoScalingPolicyin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAutoScalingConfigurations
public ListAutoScalingConfigurationsResponse listAutoScalingConfigurations(ListAutoScalingConfigurationsRequest request)
Description copied from interface:AutoScalingLists autoscaling configurations in the specifed compartment.- Specified by:
listAutoScalingConfigurationsin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAutoScalingPolicies
public ListAutoScalingPoliciesResponse listAutoScalingPolicies(ListAutoScalingPoliciesRequest request)
Description copied from interface:AutoScalingLists the autoscaling policies in the specified autoscaling configuration.- Specified by:
listAutoScalingPoliciesin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAutoScalingConfiguration
public UpdateAutoScalingConfigurationResponse updateAutoScalingConfiguration(UpdateAutoScalingConfigurationRequest request)
Description copied from interface:AutoScalingUpdates certain fields on the specified autoscaling configuration, such as the name, the cooldown period, and whether the autoscaling configuration is enabled.- Specified by:
updateAutoScalingConfigurationin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAutoScalingPolicy
public UpdateAutoScalingPolicyResponse updateAutoScalingPolicy(UpdateAutoScalingPolicyRequest request)
Description copied from interface:AutoScalingUpdates an autoscaling policy in the specified autoscaling configuration.- Specified by:
updateAutoScalingPolicyin interfaceAutoScaling- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPaginators
public AutoScalingPaginators getPaginators()
Description copied from interface:AutoScalingGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceAutoScaling- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-