Package com.oracle.bmc.clusterplacementgroups.model

Class ClusterPlacementGroup

java.lang.Object

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

com.oracle.bmc.clusterplacementgroups.model.ClusterPlacementGroup

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

A cluster placement group, which is a logical grouping of resources that offer low latency within an availability domain by being placed in close physical proximity.
Note: Objects should always be created or deserialized using the ClusterPlacementGroup.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 ClusterPlacementGroup.Builder, which maintain a set of all explicitly set fields called ClusterPlacementGroup.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	ClusterPlacementGroup.Builder
static class	ClusterPlacementGroup.LifecycleState	The current state of the ClusterPlacementGroup.

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

ClusterPlacementGroup(String id, String name, String description, String compartmentId, String availabilityDomain, ClusterPlacementGroupType clusterPlacementGroupType, Date timeCreated, Date timeUpdated, ClusterPlacementGroup.LifecycleState lifecycleState, String lifecycleDetails, PlacementInstructionDetails placementInstruction, CapabilitiesCollection capabilities, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static ClusterPlacementGroup.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAvailabilityDomain()	The availability domain of the cluster placement group.
CapabilitiesCollection	getCapabilities()
ClusterPlacementGroupType	getClusterPlacementGroupType()	The type of cluster placement group.
String	getCompartmentId()	The OCID of the compartment that contains the cluster placement group.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	A description of the cluster placement group.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type, or scope.
String	getId()	The OCID of the cluster placement group.
String	getLifecycleDetails()	A message describing the current state in more detail.
ClusterPlacementGroup.LifecycleState	getLifecycleState()	The current state of the ClusterPlacementGroup.
String	getName()	The user-friendly name of the cluster placement group.
PlacementInstructionDetails	getPlacementInstruction()
Map<String,Map<String,Object>>	getSystemTags()	System tags for this resource.
Date	getTimeCreated()	The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
Date	getTimeUpdated()	The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
int	hashCode()
ClusterPlacementGroup.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

ClusterPlacementGroup

@Deprecated
@ConstructorProperties({"id","name","description","compartmentId","availabilityDomain","clusterPlacementGroupType","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","placementInstruction","capabilities","freeformTags","definedTags","systemTags"})
public ClusterPlacementGroup(String id,
                             String name,
                             String description,
                             String compartmentId,
                             String availabilityDomain,
                             ClusterPlacementGroupType clusterPlacementGroupType,
                             Date timeCreated,
                             Date timeUpdated,
                             ClusterPlacementGroup.LifecycleState lifecycleState,
                             String lifecycleDetails,
                             PlacementInstructionDetails placementInstruction,
                             CapabilitiesCollection capabilities,
                             Map<String,String> freeformTags,
                             Map<String,Map<String,Object>> definedTags,
                             Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static ClusterPlacementGroup.Builder builder()

Create a new builder.

toBuilder

public ClusterPlacementGroup.Builder toBuilder()

getId

public String getId()

The OCID of the cluster placement group.

Returns:

the value

getName

public String getName()

The user-friendly name of the cluster placement group.

The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.

Returns:

the value

getDescription

public String getDescription()

A description of the cluster placement group.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the cluster placement group.

Returns:

the value

getAvailabilityDomain

public String getAvailabilityDomain()

The availability domain of the cluster placement group.

Returns:

the value

getClusterPlacementGroupType

public ClusterPlacementGroupType getClusterPlacementGroupType()

The type of cluster placement group.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time the cluster placement group was created, expressed in RFC 3339 timestamp format.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.

Returns:

the value

getLifecycleState

public ClusterPlacementGroup.LifecycleState getLifecycleState()

The current state of the ClusterPlacementGroup.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state in more detail.

For example, lifecycle details for a resource in a Failed state might include information to act on.

Returns:

the value

getPlacementInstruction

public PlacementInstructionDetails getPlacementInstruction()

getCapabilities

public CapabilitiesCollection getCapabilities()

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type, or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

System tags for this resource.

Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:

the value

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