Class PrivilegedApiRequestsClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.apiaccesscontrol.PrivilegedApiRequestsClient
-
- All Implemented Interfaces:
PrivilegedApiRequests,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20241130") public class PrivilegedApiRequestsClient extends BaseSyncClient implements PrivilegedApiRequests
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPrivilegedApiRequestsClient.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 PrivilegedApiRequests.
-
Constructor Summary
Constructors Constructor Description PrivilegedApiRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.PrivilegedApiRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.PrivilegedApiRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.PrivilegedApiRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.PrivilegedApiRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ApprovePrivilegedApiRequestResponseapprovePrivilegedApiRequest(ApprovePrivilegedApiRequestRequest request)Approves privilegedApi request.static PrivilegedApiRequestsClient.Builderbuilder()Create a builder for this client.voidclose()ClosePrivilegedApiRequestResponseclosePrivilegedApiRequest(ClosePrivilegedApiRequestRequest request)Closes privilegedApi request.CreatePrivilegedApiRequestResponsecreatePrivilegedApiRequest(CreatePrivilegedApiRequestRequest request)Creates a PrivilegedApiRequest.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.PrivilegedApiRequestsPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPrivilegedApiRequestResponsegetPrivilegedApiRequest(GetPrivilegedApiRequestRequest request)Gets information about a PrivilegedApiRequest.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.PrivilegedApiRequestsWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListPrivilegedApiRequestsResponselistPrivilegedApiRequests(ListPrivilegedApiRequestsRequest request)Lists all privilegedApi requests in the compartment.voidrefreshClient()Rebuild the backingHttpClient.RejectPrivilegedApiRequestResponserejectPrivilegedApiRequest(RejectPrivilegedApiRequestRequest request)Rejects privilegedApi request.RevokePrivilegedApiRequestResponserevokePrivilegedApiRequest(RevokePrivilegedApiRequestRequest request)Revokes an already approved privilegedApi request.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’).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.apiaccesscontrol.PrivilegedApiRequests
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivilegedApiRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivilegedApiRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivilegedApiRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivilegedApiRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivilegedApiRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(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 (seePrivilegedApiRequestsClient.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)
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(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 (seePrivilegedApiRequestsClient.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
-
PrivilegedApiRequestsClient
@Deprecated public PrivilegedApiRequestsClient(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 (seePrivilegedApiRequestsClient.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-PrivilegedApiRequestsClient.Builder.executorService
-
-
Method Detail
-
builder
public static PrivilegedApiRequestsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:PrivilegedApiRequestsSets 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 interfacePrivilegedApiRequests- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:PrivilegedApiRequestsSets 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 interfacePrivilegedApiRequests- Parameters:
regionId- The public region ID.
-
approvePrivilegedApiRequest
public ApprovePrivilegedApiRequestResponse approvePrivilegedApiRequest(ApprovePrivilegedApiRequestRequest request)
Description copied from interface:PrivilegedApiRequestsApproves privilegedApi request.- Specified by:
approvePrivilegedApiRequestin interfacePrivilegedApiRequests- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
closePrivilegedApiRequest
public ClosePrivilegedApiRequestResponse closePrivilegedApiRequest(ClosePrivilegedApiRequestRequest request)
Description copied from interface:PrivilegedApiRequestsCloses privilegedApi request.- Specified by:
closePrivilegedApiRequestin interfacePrivilegedApiRequests- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPrivilegedApiRequest
public CreatePrivilegedApiRequestResponse createPrivilegedApiRequest(CreatePrivilegedApiRequestRequest request)
Description copied from interface:PrivilegedApiRequestsCreates a PrivilegedApiRequest.- Specified by:
createPrivilegedApiRequestin interfacePrivilegedApiRequests- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPrivilegedApiRequest
public GetPrivilegedApiRequestResponse getPrivilegedApiRequest(GetPrivilegedApiRequestRequest request)
Description copied from interface:PrivilegedApiRequestsGets information about a PrivilegedApiRequest.- Specified by:
getPrivilegedApiRequestin interfacePrivilegedApiRequests- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPrivilegedApiRequests
public ListPrivilegedApiRequestsResponse listPrivilegedApiRequests(ListPrivilegedApiRequestsRequest request)
Description copied from interface:PrivilegedApiRequestsLists all privilegedApi requests in the compartment.- Specified by:
listPrivilegedApiRequestsin interfacePrivilegedApiRequests- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
rejectPrivilegedApiRequest
public RejectPrivilegedApiRequestResponse rejectPrivilegedApiRequest(RejectPrivilegedApiRequestRequest request)
Description copied from interface:PrivilegedApiRequestsRejects privilegedApi request.- Specified by:
rejectPrivilegedApiRequestin interfacePrivilegedApiRequests- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
revokePrivilegedApiRequest
public RevokePrivilegedApiRequestResponse revokePrivilegedApiRequest(RevokePrivilegedApiRequestRequest request)
Description copied from interface:PrivilegedApiRequestsRevokes an already approved privilegedApi request.- Specified by:
revokePrivilegedApiRequestin interfacePrivilegedApiRequests- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public PrivilegedApiRequestsWaiters getWaiters()
Description copied from interface:PrivilegedApiRequestsGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfacePrivilegedApiRequests- Returns:
- The service waiters.
-
getPaginators
public PrivilegedApiRequestsPaginators getPaginators()
Description copied from interface:PrivilegedApiRequestsGets 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 interfacePrivilegedApiRequests- 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()
-
-