@Generated(value="OracleSDKGenerator",
comments="API Version: 20240815")
public interface SecurityAttribute
extends AutoCloseable
Use the Security Attributes API to manage security attributes and security attribute namespaces. For more information, see the documentation for Security Attributes and Security Attribute Nampespaces. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
closevoid refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint - The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
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.
region - The region of the service.void setRegion(String regionId)
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.
regionId - The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint
templateBulkDeleteSecurityAttributesResponse bulkDeleteSecurityAttributes(BulkDeleteSecurityAttributesRequest request)
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
cascadeDeleteSecurityAttributeNamespace operation until this process completes.
In order to delete security attribute, you must first retire the security attribute. Use
updateSecurityAttribute to
retire a security attribute.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use BulkDeleteSecurityAttributes API.
BulkEditSecurityAttributesResponse bulkEditSecurityAttributes(BulkEditSecurityAttributesRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use BulkEditSecurityAttributes API.
CascadingDeleteSecurityAttributeNamespaceResponse cascadingDeleteSecurityAttributeNamespace(CascadingDeleteSecurityAttributeNamespaceRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CascadingDeleteSecurityAttributeNamespace API.
ChangeSecurityAttributeNamespaceCompartmentResponse changeSecurityAttributeNamespaceCompartment(ChangeSecurityAttributeNamespaceCompartmentRequest request)
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.cloud.oracle.com/Content/Identity/policyreference/iampolicyreference.htm).
Moving a security attribute namespace moves all the security attributes contained in the security attribute namespace.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeSecurityAttributeNamespaceCompartment API.
CreateSecurityAttributeResponse createSecurityAttribute(CreateSecurityAttributeRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSecurityAttribute API.
CreateSecurityAttributeNamespaceResponse createSecurityAttributeNamespace(CreateSecurityAttributeNamespaceRequest request)
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 securityAttributeNamespace.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSecurityAttributeNamespace API.
DeleteSecurityAttributeResponse deleteSecurityAttribute(DeleteSecurityAttributeRequest request)
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 cascadeDeleteTagNamespace
operation until this process completes.
To delete a security attribute, you must first retire it. Use updateSecurityAttribute to retire a
security attribute.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSecurityAttribute API.
DeleteSecurityAttributeNamespaceResponse deleteSecurityAttributeNamespace(DeleteSecurityAttributeNamespaceRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSecurityAttributeNamespace API.
GetSecurityAttributeResponse getSecurityAttribute(GetSecurityAttributeRequest request)
Gets the specified security attribute’s information.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecurityAttribute API.
GetSecurityAttributeNamespaceResponse getSecurityAttributeNamespace(GetSecurityAttributeNamespaceRequest request)
Gets the specified security attribute namespace’s information.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecurityAttributeNamespace API.
GetSecurityAttributeWorkRequestResponse getSecurityAttributeWorkRequest(GetSecurityAttributeWorkRequestRequest request)
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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSecurityAttributeWorkRequest API.
ListSecurityAttributeNamespacesResponse listSecurityAttributeNamespaces(ListSecurityAttributeNamespacesRequest request)
Lists the security attribute namespaces in the specified compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityAttributeNamespaces API.
ListSecurityAttributeWorkRequestErrorsResponse listSecurityAttributeWorkRequestErrors(ListSecurityAttributeWorkRequestErrorsRequest request)
Gets the errors for a work request.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityAttributeWorkRequestErrors API.
ListSecurityAttributeWorkRequestLogsResponse listSecurityAttributeWorkRequestLogs(ListSecurityAttributeWorkRequestLogsRequest request)
Gets the logs for a work request.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityAttributeWorkRequestLogs API.
ListSecurityAttributeWorkRequestsResponse listSecurityAttributeWorkRequests(ListSecurityAttributeWorkRequestsRequest request)
Lists the security attribute work requests in compartment.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityAttributeWorkRequests API.
ListSecurityAttributesResponse listSecurityAttributes(ListSecurityAttributesRequest request)
Lists the security attributes in the specified namespace.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSecurityAttributes API.
UpdateSecurityAttributeResponse updateSecurityAttribute(UpdateSecurityAttributeRequest request)
Updates the specified security attribute. You can only update description, and isRetired.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSecurityAttribute API.
UpdateSecurityAttributeNamespaceResponse updateSecurityAttributeNamespace(UpdateSecurityAttributeNamespaceRequest request)
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 updateTag. For more information about retiring security
attribute namespaces, see [Managing Security Attribute
Namespaces](https://docs.cloud.oracle.com/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.
request - The request object containing the details to sendBmcException - when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSecurityAttributeNamespace API.
SecurityAttributeWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
SecurityAttributePaginators getPaginators()
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.
Copyright © 2016–2024. All rights reserved.