Class WaaClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.waa.WaaClient
-
- All Implemented Interfaces:
Waa,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20211230") public class WaaClient extends BaseSyncClient implements Waa
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classWaaClient.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 Waa.
-
Constructor Summary
Constructors Constructor Description WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.WaaClient(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 WaaClient.Builderbuilder()Create a builder for this client.ChangeWebAppAccelerationCompartmentResponsechangeWebAppAccelerationCompartment(ChangeWebAppAccelerationCompartmentRequest request)Moves a Web App Acceleration resource from one compartment to another.ChangeWebAppAccelerationPolicyCompartmentResponsechangeWebAppAccelerationPolicyCompartment(ChangeWebAppAccelerationPolicyCompartmentRequest request)Moves a WebAppAccelerationfPolicy resource from one compartment to another.voidclose()CreateWebAppAccelerationResponsecreateWebAppAcceleration(CreateWebAppAccelerationRequest request)Creates a new WebAppAcceleration.CreateWebAppAccelerationPolicyResponsecreateWebAppAccelerationPolicy(CreateWebAppAccelerationPolicyRequest request)Creates a new WebAppAccelerationPolicy.DeleteWebAppAccelerationResponsedeleteWebAppAcceleration(DeleteWebAppAccelerationRequest request)Deletes a WebAppAcceleration resource identified by the OCID.DeleteWebAppAccelerationPolicyResponsedeleteWebAppAccelerationPolicy(DeleteWebAppAccelerationPolicyRequest request)Deletes a WebAppAccelerationPolicy resource identified by the OCID.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.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.WaaPaginatorsgetPaginators()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.WaaWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWebAppAccelerationResponsegetWebAppAcceleration(GetWebAppAccelerationRequest request)Gets a WebAppAcceleration by OCID.GetWebAppAccelerationPolicyResponsegetWebAppAccelerationPolicy(GetWebAppAccelerationPolicyRequest request)Gets a WebAppAccelerationPolicy with the given OCID.ListWebAppAccelerationPoliciesResponselistWebAppAccelerationPolicies(ListWebAppAccelerationPoliciesRequest request)Gets a list of all WebAppAccelerationPolicies in a compartment.ListWebAppAccelerationsResponselistWebAppAccelerations(ListWebAppAccelerationsRequest request)Gets a list of all WebAppAccelerations in a compartment.PurgeWebAppAccelerationCacheResponsepurgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request)Clears resources from the cache of the WebAppAcceleration.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’).UpdateWebAppAccelerationResponseupdateWebAppAcceleration(UpdateWebAppAccelerationRequest request)Updates the WebAppAcceleration identified by the OCID.UpdateWebAppAccelerationPolicyResponseupdateWebAppAccelerationPolicy(UpdateWebAppAccelerationPolicyRequest request)Update the WebAppAccelerationPolicy identified by the OCID.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.waa.Waa
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
WaaClient
@Deprecated public WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
WaaClient
@Deprecated public WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
WaaClient
@Deprecated public WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
WaaClient
@Deprecated public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
WaaClient
@Deprecated public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
WaaClient
@Deprecated public WaaClient(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 (seeWaaClient.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)
-
WaaClient
@Deprecated public WaaClient(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 (seeWaaClient.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
-
WaaClient
@Deprecated public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWaaClient.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.signingStrategyRequestSignerFactoriesexecutorService-WaaClient.Builder.executorService
-
-
Method Detail
-
builder
public static WaaClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:WaaSets 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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:WaaSets 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.
-
changeWebAppAccelerationCompartment
public ChangeWebAppAccelerationCompartmentResponse changeWebAppAccelerationCompartment(ChangeWebAppAccelerationCompartmentRequest request)
Description copied from interface:WaaMoves a Web App Acceleration resource from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeWebAppAccelerationCompartmentin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeWebAppAccelerationPolicyCompartment
public ChangeWebAppAccelerationPolicyCompartmentResponse changeWebAppAccelerationPolicyCompartment(ChangeWebAppAccelerationPolicyCompartmentRequest request)
Description copied from interface:WaaMoves a WebAppAccelerationfPolicy resource from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeWebAppAccelerationPolicyCompartmentin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createWebAppAcceleration
public CreateWebAppAccelerationResponse createWebAppAcceleration(CreateWebAppAccelerationRequest request)
Description copied from interface:WaaCreates a new WebAppAcceleration.- Specified by:
createWebAppAccelerationin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createWebAppAccelerationPolicy
public CreateWebAppAccelerationPolicyResponse createWebAppAccelerationPolicy(CreateWebAppAccelerationPolicyRequest request)
Description copied from interface:WaaCreates a new WebAppAccelerationPolicy.- Specified by:
createWebAppAccelerationPolicyin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteWebAppAcceleration
public DeleteWebAppAccelerationResponse deleteWebAppAcceleration(DeleteWebAppAccelerationRequest request)
Description copied from interface:WaaDeletes a WebAppAcceleration resource identified by the OCID.- Specified by:
deleteWebAppAccelerationin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteWebAppAccelerationPolicy
public DeleteWebAppAccelerationPolicyResponse deleteWebAppAccelerationPolicy(DeleteWebAppAccelerationPolicyRequest request)
Description copied from interface:WaaDeletes a WebAppAccelerationPolicy resource identified by the OCID.- Specified by:
deleteWebAppAccelerationPolicyin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWebAppAcceleration
public GetWebAppAccelerationResponse getWebAppAcceleration(GetWebAppAccelerationRequest request)
Description copied from interface:WaaGets a WebAppAcceleration by OCID.- Specified by:
getWebAppAccelerationin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWebAppAccelerationPolicy
public GetWebAppAccelerationPolicyResponse getWebAppAccelerationPolicy(GetWebAppAccelerationPolicyRequest request)
Description copied from interface:WaaGets a WebAppAccelerationPolicy with the given OCID.- Specified by:
getWebAppAccelerationPolicyin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWebAppAccelerationPolicies
public ListWebAppAccelerationPoliciesResponse listWebAppAccelerationPolicies(ListWebAppAccelerationPoliciesRequest request)
Description copied from interface:WaaGets a list of all WebAppAccelerationPolicies in a compartment.- Specified by:
listWebAppAccelerationPoliciesin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWebAppAccelerations
public ListWebAppAccelerationsResponse listWebAppAccelerations(ListWebAppAccelerationsRequest request)
Description copied from interface:WaaGets a list of all WebAppAccelerations in a compartment.- Specified by:
listWebAppAccelerationsin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
purgeWebAppAccelerationCache
public PurgeWebAppAccelerationCacheResponse purgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request)
Description copied from interface:WaaClears resources from the cache of the WebAppAcceleration.Each new request for a purged resource will be forwarded to the origin server to fetch a new version of the resource.
- Specified by:
purgeWebAppAccelerationCachein interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateWebAppAcceleration
public UpdateWebAppAccelerationResponse updateWebAppAcceleration(UpdateWebAppAccelerationRequest request)
Description copied from interface:WaaUpdates the WebAppAcceleration identified by the OCID.- Specified by:
updateWebAppAccelerationin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateWebAppAccelerationPolicy
public UpdateWebAppAccelerationPolicyResponse updateWebAppAccelerationPolicy(UpdateWebAppAccelerationPolicyRequest request)
Description copied from interface:WaaUpdate the WebAppAccelerationPolicy identified by the OCID.- Specified by:
updateWebAppAccelerationPolicyin interfaceWaa- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public WaaWaiters getWaiters()
Description copied from interface:WaaGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceWaa- Returns:
- The service waiters.
-
getPaginators
public WaaPaginators getPaginators()
Description copied from interface:WaaGets 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 interfaceWaa- 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()
-
-