Package com.oracle.bmc.securityattribute.model

Class SecurityAttribute

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.securityattribute.model.SecurityAttribute

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240815")
public final class SecurityAttribute
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A security attribute that belongs to a specific security attribute namespace.

Security attributes must be created in a tenancy before a user can apply them to resources. For more information, see Managing Security Attributes.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the SecurityAttribute.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SecurityAttribute.Builder, which maintain a set of all explicitly set fields called SecurityAttribute.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecurityAttribute.Builder
static class	SecurityAttribute.LifecycleState	The security attribute’s current state.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SecurityAttribute(String compartmentId, String securityAttributeNamespaceId, String securityAttributeNamespaceName, String id, String name, String description, String type, Boolean isRetired, SecurityAttribute.LifecycleState lifecycleState, Date timeCreated, BaseSecurityAttributeValidator validator)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SecurityAttribute.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment that contains the security attribute definition.
String	getDescription()	The description of the security attribute.
String	getId()	The OCID of the security attribute definition.
Boolean	getIsRetired()	Indicates whether the security attribute is retired.
SecurityAttribute.LifecycleState	getLifecycleState()	The security attribute’s current state.
String	getName()	The name assigned to the security attribute during creation.
String	getSecurityAttributeNamespaceId()	The OCID of the security attribute namespace that contains the security attribute definition.
String	getSecurityAttributeNamespaceName()	The name of the security attribute namespace that contains the security attribute.
Date	getTimeCreated()	Date and time the security attribute was created, in the format defined by RFC3339.
String	getType()	The data type of the security attribute.
BaseSecurityAttributeValidator	getValidator()
int	hashCode()
SecurityAttribute.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityAttribute

@Deprecated
@ConstructorProperties({"compartmentId","securityAttributeNamespaceId","securityAttributeNamespaceName","id","name","description","type","isRetired","lifecycleState","timeCreated","validator"})
public SecurityAttribute(String compartmentId,
                         String securityAttributeNamespaceId,
                         String securityAttributeNamespaceName,
                         String id,
                         String name,
                         String description,
                         String type,
                         Boolean isRetired,
                         SecurityAttribute.LifecycleState lifecycleState,
                         Date timeCreated,
                         BaseSecurityAttributeValidator validator)

Deprecated.

Method Detail

builder

public static SecurityAttribute.Builder builder()

Create a new builder.

toBuilder

public SecurityAttribute.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the security attribute definition.

Returns:

the value

getSecurityAttributeNamespaceId

public String getSecurityAttributeNamespaceId()

The OCID of the security attribute namespace that contains the security attribute definition.

Returns:

the value

getSecurityAttributeNamespaceName

public String getSecurityAttributeNamespaceName()

The name of the security attribute namespace that contains the security attribute.

Returns:

the value

getId

public String getId()

The OCID of the security attribute definition.

Returns:

the value

getName

public String getName()

The name assigned to the security attribute during creation.

This is the security attribute key. The name must be unique within the security attribute namespace and cannot be changed.

Returns:

the value

getDescription

public String getDescription()

The description of the security attribute.

Returns:

the value

getType

public String getType()

The data type of the security attribute.

Returns:

the value

getIsRetired

public Boolean getIsRetired()

Indicates whether the security attribute is retired.

See Managing Security Attribute Namespaces.

Returns:

the value

getLifecycleState

public SecurityAttribute.LifecycleState getLifecycleState()

The security attribute’s current state.

After creating a security attribute, make sure its lifecycleState is ACTIVE before using it. After retiring a security attribute, make sure its lifecycleState is INACTIVE before using it. If you delete a security attribute, you cannot delete another security attribute until the deleted tag’s lifecycleState changes from DELETING to DELETED.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

Date and time the security attribute was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getValidator

public BaseSecurityAttributeValidator getValidator()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel