Package com.oracle.bmc.securityattribute

Class SecurityAttributeAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.securityattribute.SecurityAttributeAsyncClient

All Implemented Interfaces:

SecurityAttributeAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240815")
public class SecurityAttributeAsyncClient
extends BaseAsyncClient
implements SecurityAttributeAsync

Async client implementation for SecurityAttribute service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecurityAttributeAsyncClient.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 SecurityAttribute.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SecurityAttributeAsyncClient.Builder	builder()	Create a builder for this client.
Future<BulkDeleteSecurityAttributesResponse>	bulkDeleteSecurityAttributes(BulkDeleteSecurityAttributesRequest request, AsyncHandler<BulkDeleteSecurityAttributesRequest,BulkDeleteSecurityAttributesResponse> handler)	Deletes the specified security attribute definitions.
Future<BulkEditSecurityAttributesResponse>	bulkEditSecurityAttributes(BulkEditSecurityAttributesRequest request, AsyncHandler<BulkEditSecurityAttributesRequest,BulkEditSecurityAttributesResponse> handler)	Edits the specified list of security attributes for the selected resources.
Future<CascadingDeleteSecurityAttributeNamespaceResponse>	cascadingDeleteSecurityAttributeNamespace(CascadingDeleteSecurityAttributeNamespaceRequest request, AsyncHandler<CascadingDeleteSecurityAttributeNamespaceRequest,CascadingDeleteSecurityAttributeNamespaceResponse> handler)	Deletes the specified security attribute namespace.
Future<ChangeSecurityAttributeNamespaceCompartmentResponse>	changeSecurityAttributeNamespaceCompartment(ChangeSecurityAttributeNamespaceCompartmentRequest request, AsyncHandler<ChangeSecurityAttributeNamespaceCompartmentRequest,ChangeSecurityAttributeNamespaceCompartmentResponse> handler)	Moves the specified security attribute namespace to the specified compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateSecurityAttributeResponse>	createSecurityAttribute(CreateSecurityAttributeRequest request, AsyncHandler<CreateSecurityAttributeRequest,CreateSecurityAttributeResponse> handler)	Creates a new security attribute in the specified security attribute namespace.
Future<CreateSecurityAttributeNamespaceResponse>	createSecurityAttributeNamespace(CreateSecurityAttributeNamespaceRequest request, AsyncHandler<CreateSecurityAttributeNamespaceRequest,CreateSecurityAttributeNamespaceResponse> handler)	Creates a new security attribute namespace in the specified compartment.
Future<DeleteSecurityAttributeResponse>	deleteSecurityAttribute(DeleteSecurityAttributeRequest request, AsyncHandler<DeleteSecurityAttributeRequest,DeleteSecurityAttributeResponse> handler)	Deletes the specified security attribute.
Future<DeleteSecurityAttributeNamespaceResponse>	deleteSecurityAttributeNamespace(DeleteSecurityAttributeNamespaceRequest request, AsyncHandler<DeleteSecurityAttributeNamespaceRequest,DeleteSecurityAttributeNamespaceResponse> handler)	Deletes the specified security attribute namespace.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetSecurityAttributeResponse>	getSecurityAttribute(GetSecurityAttributeRequest request, AsyncHandler<GetSecurityAttributeRequest,GetSecurityAttributeResponse> handler)	Gets the specified security attribute’s information.
Future<GetSecurityAttributeNamespaceResponse>	getSecurityAttributeNamespace(GetSecurityAttributeNamespaceRequest request, AsyncHandler<GetSecurityAttributeNamespaceRequest,GetSecurityAttributeNamespaceResponse> handler)	Gets the specified security attribute namespace’s information.
Future<GetSecurityAttributeWorkRequestResponse>	getSecurityAttributeWorkRequest(GetSecurityAttributeWorkRequestRequest request, AsyncHandler<GetSecurityAttributeWorkRequestRequest,GetSecurityAttributeWorkRequestResponse> handler)	Gets details on a specified work request.
Future<ListSecurityAttributeNamespacesResponse>	listSecurityAttributeNamespaces(ListSecurityAttributeNamespacesRequest request, AsyncHandler<ListSecurityAttributeNamespacesRequest,ListSecurityAttributeNamespacesResponse> handler)	Lists the security attribute namespaces in the specified compartment.
Future<ListSecurityAttributesResponse>	listSecurityAttributes(ListSecurityAttributesRequest request, AsyncHandler<ListSecurityAttributesRequest,ListSecurityAttributesResponse> handler)	Lists the security attributes in the specified namespace.
Future<ListSecurityAttributeWorkRequestErrorsResponse>	listSecurityAttributeWorkRequestErrors(ListSecurityAttributeWorkRequestErrorsRequest request, AsyncHandler<ListSecurityAttributeWorkRequestErrorsRequest,ListSecurityAttributeWorkRequestErrorsResponse> handler)	Gets the errors for a work request.
Future<ListSecurityAttributeWorkRequestLogsResponse>	listSecurityAttributeWorkRequestLogs(ListSecurityAttributeWorkRequestLogsRequest request, AsyncHandler<ListSecurityAttributeWorkRequestLogsRequest,ListSecurityAttributeWorkRequestLogsResponse> handler)	Gets the logs for a work request.
Future<ListSecurityAttributeWorkRequestsResponse>	listSecurityAttributeWorkRequests(ListSecurityAttributeWorkRequestsRequest request, AsyncHandler<ListSecurityAttributeWorkRequestsRequest,ListSecurityAttributeWorkRequestsResponse> handler)	Lists the security attribute work requests in compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
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	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateSecurityAttributeResponse>	updateSecurityAttribute(UpdateSecurityAttributeRequest request, AsyncHandler<UpdateSecurityAttributeRequest,UpdateSecurityAttributeResponse> handler)	Updates the specified security attribute.
Future<UpdateSecurityAttributeNamespaceResponse>	updateSecurityAttributeNamespace(UpdateSecurityAttributeNamespaceRequest request, AsyncHandler<UpdateSecurityAttributeNamespaceRequest,UpdateSecurityAttributeNamespaceResponse> handler)	Updates the specified security attribute namespace.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

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.securityattribute.SecurityAttributeAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for SecurityAttribute.

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

SecurityAttributeAsyncClient

@Deprecated
public SecurityAttributeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

SecurityAttributeAsyncClient

@Deprecated
public SecurityAttributeAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

SecurityAttributeAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

SecurityAttributeAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

SecurityAttributeAsyncClient

@Deprecated
public SecurityAttributeAsyncClient(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 SecurityAttributeAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

SecurityAttributeAsyncClient

@Deprecated
public SecurityAttributeAsyncClient(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 SecurityAttributeAsyncClient.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)

SecurityAttributeAsyncClient

@Deprecated
public SecurityAttributeAsyncClient(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 SecurityAttributeAsyncClient.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

Method Detail

builder

public static SecurityAttributeAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: SecurityAttributeAsync

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 SecurityAttributeAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: SecurityAttributeAsync

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 SecurityAttributeAsync

Parameters:

regionId - The public region ID.

bulkDeleteSecurityAttributes

public Future<BulkDeleteSecurityAttributesResponse> bulkDeleteSecurityAttributes(BulkDeleteSecurityAttributesRequest request,
                                                                                 AsyncHandler<BulkDeleteSecurityAttributesRequest,BulkDeleteSecurityAttributesResponse> handler)

Description copied from interface: SecurityAttributeAsync

Deletes the specified security attribute definitions.

This operation triggers a process that removes the security attributes from all resources in your tenancy. The security attributes must be within the same security attribute namespace.

The following actions happen immediately:

After you start this operation, the state of the tag changes to DELETING, and security attribute removal from resources begins. This process can take up to 48 hours depending on the number of resources that are tagged and the regions in which those resources reside.

When all security attributes have been removed, the state changes to DELETED. You cannot restore a deleted security attribute. After the security attribute state changes to DELETED, you can use the same security attribute name again.

After you start this operation, you cannot start either the deleteSecurityAttribute or the cascadingDeleteSecurityAttributeNamespace operation until this process completes.

In order to delete security attribute, you must first retire the security attribute. Use updateSecurityAttributeNamespace to retire a security attribute.

Specified by:

bulkDeleteSecurityAttributes in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

bulkEditSecurityAttributes

public Future<BulkEditSecurityAttributesResponse> bulkEditSecurityAttributes(BulkEditSecurityAttributesRequest request,
                                                                             AsyncHandler<BulkEditSecurityAttributesRequest,BulkEditSecurityAttributesResponse> handler)

Description copied from interface: SecurityAttributeAsync

Edits the specified list of security attributes for the selected resources.

This operation triggers a process that edits the attributes on all selected resources. The possible actions are:

Add a security attribute when it does not already exist on the resource. * Update the value for a security attribute when it is present on the resource. * Add a security attribute when it does not already exist on the resource or update the value when it is present on the resource. * Remove a security attribute from a resource. The security attribute is removed from the resource regardless of the value.

The edits can include a combination of operations and attributes. However, multiple operations cannot apply to the same attribute in the same request.

Specified by:

bulkEditSecurityAttributes in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

cascadingDeleteSecurityAttributeNamespace

public Future<CascadingDeleteSecurityAttributeNamespaceResponse> cascadingDeleteSecurityAttributeNamespace(CascadingDeleteSecurityAttributeNamespaceRequest request,
                                                                                                           AsyncHandler<CascadingDeleteSecurityAttributeNamespaceRequest,CascadingDeleteSecurityAttributeNamespaceResponse> handler)

Description copied from interface: SecurityAttributeAsync

Deletes the specified security attribute namespace.

This operation triggers a process that removes all of the security attributes defined in the specified security attribute namespace from all resources in your tenancy and then deletes the security attribute namespace.

After you start the delete operation:

New security attribute key definitions cannot be created under the namespace. * The state of the security attribute namespace changes to DELETING. * Security attribute removal from the resources begins.

This process can take up to 48 hours depending on the number of security attributes in the namespace, the number of resources that are tagged, and the locations of the regions in which those resources reside.

After all security attributes are removed, the state changes to DELETED. You cannot restore a deleted security attribute namespace. After the deleted security attribute namespace changes its state to DELETED, you can use the name of the deleted security attribute namespace again.

After you start this operation, you cannot start either the deleteSecurityAttribute or the bulkDeleteSecurityAttributes operation until this process completes.

To delete a security attribute namespace, you must first retire it. Use updateSecurityAttributeNamespace to retire a security attribute namespace.

Specified by:

cascadingDeleteSecurityAttributeNamespace in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeSecurityAttributeNamespaceCompartment

public Future<ChangeSecurityAttributeNamespaceCompartmentResponse> changeSecurityAttributeNamespaceCompartment(ChangeSecurityAttributeNamespaceCompartmentRequest request,
                                                                                                               AsyncHandler<ChangeSecurityAttributeNamespaceCompartmentRequest,ChangeSecurityAttributeNamespaceCompartmentResponse> handler)

Description copied from interface: SecurityAttributeAsync

Moves the specified security attribute namespace to the specified compartment within the same tenancy.

To move the security attribute namespace, you must have the manage security-attributes permission on both compartments. For more information about IAM policies, see [Details for IAM](https://docs.oracle.com/iaas/Content/Identity/policyreference/iampolicyreference.htm).

Moving a security attribute namespace moves all the security attributes contained in the security attribute namespace.

Specified by:

changeSecurityAttributeNamespaceCompartment in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createSecurityAttribute

public Future<CreateSecurityAttributeResponse> createSecurityAttribute(CreateSecurityAttributeRequest request,
                                                                       AsyncHandler<CreateSecurityAttributeRequest,CreateSecurityAttributeResponse> handler)

Description copied from interface: SecurityAttributeAsync

Creates a new security attribute in the specified security attribute namespace.

The security attribute requires either the OCID or the name of the security attribute namespace that will contain this security attribute.

You must specify a *name* for the attribute, which must be unique across all attributes in the security attribute namespace and cannot be changed. The only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters. Names are case insensitive. That means, for example, \"mySecurityAttribute\" and \"mysecurityattribute\" are not allowed in the same namespace. If you specify a name that's already in use in the security attribute namespace, a 409 error is returned.

The security attribute must have a *description*. It does not have to be unique, and you can change it with updateSecurityAttribute.

The security attribute must have a value type, which is specified with a validator. Security attribute can use either a static value or a list of possible values. Static values are entered by a user applying the security attribute to a resource. Lists are created by the user and the user must apply a value from the list. Lists are validated.

Specified by:

createSecurityAttribute in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createSecurityAttributeNamespace

public Future<CreateSecurityAttributeNamespaceResponse> createSecurityAttributeNamespace(CreateSecurityAttributeNamespaceRequest request,
                                                                                         AsyncHandler<CreateSecurityAttributeNamespaceRequest,CreateSecurityAttributeNamespaceResponse> handler)

Description copied from interface: SecurityAttributeAsync

Creates a new security attribute namespace in the specified compartment.

You must specify the compartment ID in the request object (remember that the tenancy is simply the root compartment).

You must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy and cannot be changed. The only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters. Names are case insensitive. That means, for example, \"myNamespace\" and \"mynamespace\" are not allowed in the same tenancy. Once you created a namespace, you cannot change the name. If you specify a name that's already in use in the tenancy, a 409 error is returned.

You must also specify a *description* for the namespace. It does not have to be unique, and you can change it with updateSecurityAttributeNamespace.

Specified by:

createSecurityAttributeNamespace in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteSecurityAttribute

public Future<DeleteSecurityAttributeResponse> deleteSecurityAttribute(DeleteSecurityAttributeRequest request,
                                                                       AsyncHandler<DeleteSecurityAttributeRequest,DeleteSecurityAttributeResponse> handler)

Description copied from interface: SecurityAttributeAsync

Deletes the specified security attribute.

This operation triggers a process that removes the security attribute from all resources in your tenancy.

When you start the delete operation, the state of the security attribute changes to DELETING and security attribute removal from resources begins. This can take up to 48 hours depending on the number of resources that were tagged as well as the regions in which those resources reside.

When all attributes have been removed, the state changes to DELETED. You cannot restore a deleted attribute. Once the deleted attribute changes its state to DELETED, you can use the same security attribute name again.

After you start this operation, you cannot start either the bulkDeleteSecurityAttributes or the cascadingDeleteSecurityAttributeNamespace operation until this process completes.

To delete a security attribute, you must first retire it. Use updateSecurityAttribute to retire a security attribute.

Specified by:

deleteSecurityAttribute in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteSecurityAttributeNamespace

public Future<DeleteSecurityAttributeNamespaceResponse> deleteSecurityAttributeNamespace(DeleteSecurityAttributeNamespaceRequest request,
                                                                                         AsyncHandler<DeleteSecurityAttributeNamespaceRequest,DeleteSecurityAttributeNamespaceResponse> handler)

Description copied from interface: SecurityAttributeAsync

Deletes the specified security attribute namespace.

Only an empty security attribute namespace can be deleted with this operation. To use this operation to delete a security attribute namespace that contains security attributes, first delete all of its security attributes. Use deleteSecurityAttribute to delete a security attribute.

Specified by:

deleteSecurityAttributeNamespace in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSecurityAttribute

public Future<GetSecurityAttributeResponse> getSecurityAttribute(GetSecurityAttributeRequest request,
                                                                 AsyncHandler<GetSecurityAttributeRequest,GetSecurityAttributeResponse> handler)

Description copied from interface: SecurityAttributeAsync

Gets the specified security attribute’s information.

Specified by:

getSecurityAttribute in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSecurityAttributeNamespace

public Future<GetSecurityAttributeNamespaceResponse> getSecurityAttributeNamespace(GetSecurityAttributeNamespaceRequest request,
                                                                                   AsyncHandler<GetSecurityAttributeNamespaceRequest,GetSecurityAttributeNamespaceResponse> handler)

Description copied from interface: SecurityAttributeAsync

Gets the specified security attribute namespace’s information.

Specified by:

getSecurityAttributeNamespace in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getSecurityAttributeWorkRequest

public Future<GetSecurityAttributeWorkRequestResponse> getSecurityAttributeWorkRequest(GetSecurityAttributeWorkRequestRequest request,
                                                                                       AsyncHandler<GetSecurityAttributeWorkRequestRequest,GetSecurityAttributeWorkRequestResponse> handler)

Description copied from interface: SecurityAttributeAsync

Gets details on a specified work request.

The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in security attributes service.

Specified by:

getSecurityAttributeWorkRequest in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSecurityAttributeNamespaces

public Future<ListSecurityAttributeNamespacesResponse> listSecurityAttributeNamespaces(ListSecurityAttributeNamespacesRequest request,
                                                                                       AsyncHandler<ListSecurityAttributeNamespacesRequest,ListSecurityAttributeNamespacesResponse> handler)

Description copied from interface: SecurityAttributeAsync

Lists the security attribute namespaces in the specified compartment.

Specified by:

listSecurityAttributeNamespaces in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSecurityAttributeWorkRequestErrors

public Future<ListSecurityAttributeWorkRequestErrorsResponse> listSecurityAttributeWorkRequestErrors(ListSecurityAttributeWorkRequestErrorsRequest request,
                                                                                                     AsyncHandler<ListSecurityAttributeWorkRequestErrorsRequest,ListSecurityAttributeWorkRequestErrorsResponse> handler)

Description copied from interface: SecurityAttributeAsync

Gets the errors for a work request.

Specified by:

listSecurityAttributeWorkRequestErrors in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSecurityAttributeWorkRequestLogs

public Future<ListSecurityAttributeWorkRequestLogsResponse> listSecurityAttributeWorkRequestLogs(ListSecurityAttributeWorkRequestLogsRequest request,
                                                                                                 AsyncHandler<ListSecurityAttributeWorkRequestLogsRequest,ListSecurityAttributeWorkRequestLogsResponse> handler)

Description copied from interface: SecurityAttributeAsync

Gets the logs for a work request.

Specified by:

listSecurityAttributeWorkRequestLogs in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSecurityAttributeWorkRequests

public Future<ListSecurityAttributeWorkRequestsResponse> listSecurityAttributeWorkRequests(ListSecurityAttributeWorkRequestsRequest request,
                                                                                           AsyncHandler<ListSecurityAttributeWorkRequestsRequest,ListSecurityAttributeWorkRequestsResponse> handler)

Description copied from interface: SecurityAttributeAsync

Lists the security attribute work requests in compartment.

Specified by:

listSecurityAttributeWorkRequests in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listSecurityAttributes

public Future<ListSecurityAttributesResponse> listSecurityAttributes(ListSecurityAttributesRequest request,
                                                                     AsyncHandler<ListSecurityAttributesRequest,ListSecurityAttributesResponse> handler)

Description copied from interface: SecurityAttributeAsync

Lists the security attributes in the specified namespace.

Specified by:

listSecurityAttributes in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSecurityAttribute

public Future<UpdateSecurityAttributeResponse> updateSecurityAttribute(UpdateSecurityAttributeRequest request,
                                                                       AsyncHandler<UpdateSecurityAttributeRequest,UpdateSecurityAttributeResponse> handler)

Description copied from interface: SecurityAttributeAsync

Updates the specified security attribute.

You can only update description, and isRetired.

Specified by:

updateSecurityAttribute in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateSecurityAttributeNamespace

public Future<UpdateSecurityAttributeNamespaceResponse> updateSecurityAttributeNamespace(UpdateSecurityAttributeNamespaceRequest request,
                                                                                         AsyncHandler<UpdateSecurityAttributeNamespaceRequest,UpdateSecurityAttributeNamespaceResponse> handler)

Description copied from interface: SecurityAttributeAsync

Updates the specified security attribute namespace.

You can’t update the namespace name.

Updating `isRetired` to 'true' retires the namespace and all the security attributes in the namespace. Reactivating a namespace (changing `isRetired` from 'true' to 'false') does not reactivate security attributes. To reactivate the security attributes, you must reactivate each one individually *after* you reactivate the namespace, using updateSecurityAttribute. For more information about retiring security attribute namespaces, see [Managing Security Attribute Namespaces](https://docs.oracle.com/iaas/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm).

You can't add a namespace with the same name as a retired namespace in the same tenancy.

Specified by:

updateSecurityAttributeNamespace in interface SecurityAttributeAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

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

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

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()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)