Package com.oracle.bmc.apiplatform.model

Class ApiPlatformInstance

java.lang.Object

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

com.oracle.bmc.apiplatform.model.ApiPlatformInstance

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

A Logical Entity that can be used to create, manage, secure, and advertise APIs to connect to new or existing services
Note: Objects should always be created or deserialized using the ApiPlatformInstance.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 ApiPlatformInstance.Builder, which maintain a set of all explicitly set fields called ApiPlatformInstance.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	ApiPlatformInstance.Builder
static class	ApiPlatformInstance.LifecycleState	The current state of the instance

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
ApiPlatformInstance(String id, String description, String name, String compartmentId, IdcsApp idcsApp, Uris uris, Date timeCreated, Date timeUpdated, ApiPlatformInstance.LifecycleState lifecycleState, String lifecycleDetails, 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 ApiPlatformInstance.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	User-provided changeable and non-unique description of the instance
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	The OCID of the instance
IdcsApp	getIdcsApp()
String	getLifecycleDetails()	A message that describes the current state of the instance in more detail.
ApiPlatformInstance.LifecycleState	getLifecycleState()	The current state of the instance
String	getName()	A regionally unique, non-changeable instance name provided by the user during instance creation
Map<String,Map<String,Object>>	getSystemTags()	System tags for this resource.
Date	getTimeCreated()	The date and time the instance was created, in the format defined by RFC 3339
Date	getTimeUpdated()	The date and time the instance was updated, in the format defined by RFC 3339
Uris	getUris()
int	hashCode()
ApiPlatformInstance.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

ApiPlatformInstance

@Deprecated
@ConstructorProperties({"id","description","name","compartmentId","idcsApp","uris","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"})
public ApiPlatformInstance(String id,
                           String description,
                           String name,
                           String compartmentId,
                           IdcsApp idcsApp,
                           Uris uris,
                           Date timeCreated,
                           Date timeUpdated,
                           ApiPlatformInstance.LifecycleState lifecycleState,
                           String lifecycleDetails,
                           Map<String,String> freeformTags,
                           Map<String,Map<String,Object>> definedTags,
                           Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static ApiPlatformInstance.Builder builder()

Create a new builder.

toBuilder

public ApiPlatformInstance.Builder toBuilder()

getId

public String getId()

The OCID of the instance

Returns:

the value

getDescription

public String getDescription()

User-provided changeable and non-unique description of the instance

Returns:

the value

getName

public String getName()

A regionally unique, non-changeable instance name provided by the user during instance creation

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment

Returns:

the value

getIdcsApp

public IdcsApp getIdcsApp()

getUris

public Uris getUris()

getTimeCreated

public Date getTimeCreated()

The date and time the instance was created, in the format defined by RFC 3339

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

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the instance was updated, in the format defined by RFC 3339

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

Returns:

the value

getLifecycleState

public ApiPlatformInstance.LifecycleState getLifecycleState()

The current state of the instance

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message that describes the current state of the instance in more detail.

For example, can be used to provide actionable information for a resource in the Failed state

Returns:

the value

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