Package com.oracle.bmc.operatoraccesscontrol

Class AccessRequestsClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.operatoraccesscontrol.AccessRequestsClient

All Implemented Interfaces:

AccessRequests, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class AccessRequestsClient
extends BaseSyncClient
implements AccessRequests

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessRequestsClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for AccessRequests.

Constructor Summary

Constructors

Constructor	Description
AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
ApproveAccessRequestResponse	approveAccessRequest(ApproveAccessRequestRequest request)	Approves an access request.
static AccessRequestsClient.Builder	builder()	Create a builder for this client.
void	close()
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
GetAccessRequestResponse	getAccessRequest(GetAccessRequestRequest request)	Gets details of an access request.
GetAuditLogReportResponse	getAuditLogReport(GetAuditLogReportRequest request)	Gets the Audit Log Report for the given access requestId.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()	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.
AccessRequestsPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
String	getResolvedEndpoint(Map<String,Object> requiredParametersMap)	Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
AccessRequestsWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
InteractionRequestResponse	interactionRequest(InteractionRequestRequest request)	Posts query for additional information for the given access request.
ListAccessRequestHistoriesResponse	listAccessRequestHistories(ListAccessRequestHistoriesRequest request)	Returns a history of all status associated with the accessRequestId.
ListAccessRequestsResponse	listAccessRequests(ListAccessRequestsRequest request)	Lists all access requests in the compartment.
ListInteractionsResponse	listInteractions(ListInteractionsRequest request)	Lists the MoreInformation interaction between customer and operators.
void	refreshClient()	Rebuild the backing HttpClient.
RejectAccessRequestResponse	rejectAccessRequest(RejectAccessRequestRequest request)	Rejects an access request.
ReviewAccessRequestResponse	reviewAccessRequest(ReviewAccessRequestRequest request)	Reviews the access request.
RevokeAccessRequestResponse	revokeAccessRequest(RevokeAccessRequestRequest request)	Revokes an already approved access request.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
void	useRealmSpecificEndpointTemplate(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 com.oracle.bmc.operatoraccesscontrol.AccessRequests

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AccessRequests.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

AccessRequestsClient

@Deprecated
public AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

AccessRequestsClient

@Deprecated
public AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

AccessRequestsClient

@Deprecated
public AccessRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

AccessRequestsClient

@Deprecated
public AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AccessRequestsClient

@Deprecated
public AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AccessRequestsClient

@Deprecated
public AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

AccessRequestsClient

@Deprecated
public AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

AccessRequestsClient

@Deprecated
public AccessRequestsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint,
                            ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AccessRequestsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - AccessRequestsClient.Builder.executorService

Method Detail

builder

public static AccessRequestsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: AccessRequests

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface AccessRequests

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AccessRequests

Sets 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 call setEndpoint.

Specified by:

setRegion in interface AccessRequests

Parameters:

regionId - The public region ID.

approveAccessRequest

public ApproveAccessRequestResponse approveAccessRequest(ApproveAccessRequestRequest request)

Description copied from interface: AccessRequests

Approves an access request.

Specified by:

approveAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAccessRequest

public GetAccessRequestResponse getAccessRequest(GetAccessRequestRequest request)

Description copied from interface: AccessRequests

Gets details of an access request.

Specified by:

getAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAuditLogReport

public GetAuditLogReportResponse getAuditLogReport(GetAuditLogReportRequest request)

Description copied from interface: AccessRequests

Gets the Audit Log Report for the given access requestId.

Specified by:

getAuditLogReport in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

interactionRequest

public InteractionRequestResponse interactionRequest(InteractionRequestRequest request)

Description copied from interface: AccessRequests

Posts query for additional information for the given access request.

Specified by:

interactionRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAccessRequestHistories

public ListAccessRequestHistoriesResponse listAccessRequestHistories(ListAccessRequestHistoriesRequest request)

Description copied from interface: AccessRequests

Returns a history of all status associated with the accessRequestId.

Specified by:

listAccessRequestHistories in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAccessRequests

public ListAccessRequestsResponse listAccessRequests(ListAccessRequestsRequest request)

Description copied from interface: AccessRequests

Lists all access requests in the compartment.

Specified by:

listAccessRequests in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInteractions

public ListInteractionsResponse listInteractions(ListInteractionsRequest request)

Description copied from interface: AccessRequests

Lists the MoreInformation interaction between customer and operators.

Specified by:

listInteractions in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rejectAccessRequest

public RejectAccessRequestResponse rejectAccessRequest(RejectAccessRequestRequest request)

Description copied from interface: AccessRequests

Rejects an access request.

Specified by:

rejectAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

reviewAccessRequest

public ReviewAccessRequestResponse reviewAccessRequest(ReviewAccessRequestRequest request)

Description copied from interface: AccessRequests

Reviews the access request.

Specified by:

reviewAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

revokeAccessRequest

public RevokeAccessRequestResponse revokeAccessRequest(RevokeAccessRequestRequest request)

Description copied from interface: AccessRequests

Revokes an already approved access request.

Specified by:

revokeAccessRequest in interface AccessRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public AccessRequestsWaiters getWaiters()

Description copied from interface: AccessRequests

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface AccessRequests

Returns:

The service waiters.

getPaginators

public AccessRequestsPaginators getPaginators()

Description copied from interface: AccessRequests

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface AccessRequests

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 by BaseClient.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) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

Returns:

the endpoint being used by the client

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()