Class OciCacheConfigSetClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.redis.OciCacheConfigSetClient
-
- All Implemented Interfaces:
OciCacheConfigSet,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20220315") public class OciCacheConfigSetClient extends BaseSyncClient implements OciCacheConfigSet
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOciCacheConfigSetClient.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 OciCacheConfigSet.
-
Constructor Summary
Constructors Constructor Description OciCacheConfigSetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.OciCacheConfigSetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.OciCacheConfigSetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.OciCacheConfigSetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.OciCacheConfigSetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.OciCacheConfigSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.OciCacheConfigSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.OciCacheConfigSetClient(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 OciCacheConfigSetClient.Builderbuilder()Create a builder for this client.ChangeOciCacheConfigSetCompartmentResponsechangeOciCacheConfigSetCompartment(ChangeOciCacheConfigSetCompartmentRequest request)Moves an OCI Cache Config Set into a different compartment within the same tenancy.voidclose()CreateOciCacheConfigSetResponsecreateOciCacheConfigSet(CreateOciCacheConfigSetRequest request)Create a new OCI Cache Config Set for the given OCI cache engine version.DeleteOciCacheConfigSetResponsedeleteOciCacheConfigSet(DeleteOciCacheConfigSetRequest request)Deletes the specified OCI Cache Config Set.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()GetOciCacheConfigSetResponsegetOciCacheConfigSet(GetOciCacheConfigSetRequest request)Retrieves the specified OCI Cache Config Set.Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.OciCacheConfigSetPaginatorsgetPaginators()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.OciCacheConfigSetWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListAssociatedOciCacheClustersResponselistAssociatedOciCacheClusters(ListAssociatedOciCacheClustersRequest request)Gets a list of associated OCI Cache clusters for an OCI Cache Config Set.ListOciCacheConfigSetsResponselistOciCacheConfigSets(ListOciCacheConfigSetsRequest request)Lists the OCI Cache Config Sets in the specified compartment.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’).UpdateOciCacheConfigSetResponseupdateOciCacheConfigSet(UpdateOciCacheConfigSetRequest request)Updates the specified OCI Cache Config Set.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.redis.OciCacheConfigSet
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOciCacheConfigSetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOciCacheConfigSetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOciCacheConfigSetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOciCacheConfigSetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeOciCacheConfigSetClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(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 (seeOciCacheConfigSetClient.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)
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(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 (seeOciCacheConfigSetClient.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
-
OciCacheConfigSetClient
@Deprecated public OciCacheConfigSetClient(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 (seeOciCacheConfigSetClient.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-OciCacheConfigSetClient.Builder.executorService
-
-
Method Detail
-
builder
public static OciCacheConfigSetClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:OciCacheConfigSetSets 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 interfaceOciCacheConfigSet- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:OciCacheConfigSetSets 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 interfaceOciCacheConfigSet- Parameters:
regionId- The public region ID.
-
changeOciCacheConfigSetCompartment
public ChangeOciCacheConfigSetCompartmentResponse changeOciCacheConfigSetCompartment(ChangeOciCacheConfigSetCompartmentRequest request)
Description copied from interface:OciCacheConfigSetMoves an OCI Cache Config Set into a different compartment within the same tenancy.- Specified by:
changeOciCacheConfigSetCompartmentin interfaceOciCacheConfigSet- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOciCacheConfigSet
public CreateOciCacheConfigSetResponse createOciCacheConfigSet(CreateOciCacheConfigSetRequest request)
Description copied from interface:OciCacheConfigSetCreate a new OCI Cache Config Set for the given OCI cache engine version.- Specified by:
createOciCacheConfigSetin interfaceOciCacheConfigSet- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOciCacheConfigSet
public DeleteOciCacheConfigSetResponse deleteOciCacheConfigSet(DeleteOciCacheConfigSetRequest request)
Description copied from interface:OciCacheConfigSetDeletes the specified OCI Cache Config Set.- Specified by:
deleteOciCacheConfigSetin interfaceOciCacheConfigSet- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOciCacheConfigSet
public GetOciCacheConfigSetResponse getOciCacheConfigSet(GetOciCacheConfigSetRequest request)
Description copied from interface:OciCacheConfigSetRetrieves the specified OCI Cache Config Set.- Specified by:
getOciCacheConfigSetin interfaceOciCacheConfigSet- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAssociatedOciCacheClusters
public ListAssociatedOciCacheClustersResponse listAssociatedOciCacheClusters(ListAssociatedOciCacheClustersRequest request)
Description copied from interface:OciCacheConfigSetGets a list of associated OCI Cache clusters for an OCI Cache Config Set.- Specified by:
listAssociatedOciCacheClustersin interfaceOciCacheConfigSet- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOciCacheConfigSets
public ListOciCacheConfigSetsResponse listOciCacheConfigSets(ListOciCacheConfigSetsRequest request)
Description copied from interface:OciCacheConfigSetLists the OCI Cache Config Sets in the specified compartment.- Specified by:
listOciCacheConfigSetsin interfaceOciCacheConfigSet- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOciCacheConfigSet
public UpdateOciCacheConfigSetResponse updateOciCacheConfigSet(UpdateOciCacheConfigSetRequest request)
Description copied from interface:OciCacheConfigSetUpdates the specified OCI Cache Config Set.- Specified by:
updateOciCacheConfigSetin interfaceOciCacheConfigSet- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public OciCacheConfigSetWaiters getWaiters()
Description copied from interface:OciCacheConfigSetGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceOciCacheConfigSet- Returns:
- The service waiters.
-
getPaginators
public OciCacheConfigSetPaginators getPaginators()
Description copied from interface:OciCacheConfigSetGets 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 interfaceOciCacheConfigSet- 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()
-
-