com.oracle.bmc.oda.model

Class CreateOdaInstanceDetails

java.lang.Object

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

com.oracle.bmc.oda.model.CreateOdaInstanceDetails

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

Properties that are required to create a Digital Assistant instance.
Note: Objects should always be created or deserialized using the CreateOdaInstanceDetails.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 CreateOdaInstanceDetails.Builder, which maintain a set of all explicitly set fields called CreateOdaInstanceDetails.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 and Description
static class	CreateOdaInstanceDetails.Builder
static class	CreateOdaInstanceDetails.ShapeName Shape or size 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 and Description
CreateOdaInstanceDetails(String displayName, String description, String compartmentId, CreateOdaInstanceDetails.ShapeName shapeName, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Boolean isRoleBasedAccess, String identityDomain) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateOdaInstanceDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCompartmentId() Identifier of the compartment.
Map<String,Map<String,Object>>	getDefinedTags() Usage of predefined tag keys.
String	getDescription() Description of the Digital Assistant instance.
String	getDisplayName() User-friendly name for the instance.
Map<String,String>	getFreeformTags() Simple key-value pair that is applied without any predefined name, type, or scope.
String	getIdentityDomain() If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation.
Boolean	getIsRoleBasedAccess() Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
CreateOdaInstanceDetails.ShapeName	getShapeName() Shape or size of the instance.
int	hashCode()
CreateOdaInstanceDetails.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

CreateOdaInstanceDetails

@Deprecated
 @ConstructorProperties(value={"displayName","description","compartmentId","shapeName","freeformTags","definedTags","isRoleBasedAccess","identityDomain"})
public CreateOdaInstanceDetails(String displayName,
                                                                                                                                                                                                       String description,
                                                                                                                                                                                                       String compartmentId,
                                                                                                                                                                                                       CreateOdaInstanceDetails.ShapeName shapeName,
                                                                                                                                                                                                       Map<String,String> freeformTags,
                                                                                                                                                                                                       Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                       Boolean isRoleBasedAccess,
                                                                                                                                                                                                       String identityDomain)

Deprecated.

Method Detail

builder

public static CreateOdaInstanceDetails.Builder builder()

Create a new builder.

toBuilder

public CreateOdaInstanceDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.

Returns:

the value

getDescription

public String getDescription()

Description of the Digital Assistant instance.

Returns:

the value

getCompartmentId

public String getCompartmentId()

Identifier of the compartment.

Returns:

the value

getShapeName

public CreateOdaInstanceDetails.ShapeName getShapeName()

Shape or size of the instance.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}

Returns:

the value

getDefinedTags

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}}

Returns:

the value

getIsRoleBasedAccess

public Boolean getIsRoleBasedAccess()

Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)

Returns:

the value

getIdentityDomain

public String getIdentityDomain()

If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.

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