com.oracle.bmc.oda.model

Class OdaInstance.Builder

java.lang.Object

com.oracle.bmc.oda.model.OdaInstance.Builder

Enclosing class:

OdaInstance

public static class OdaInstance.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OdaInstance.Builder	attachmentIds(List<String> attachmentIds) A list of attachment identifiers for this instance (if any).
OdaInstance.Builder	attachmentTypes(List<String> attachmentTypes) A list of attachment types for this instance (if any).
OdaInstance	build()
OdaInstance.Builder	compartmentId(String compartmentId) Identifier of the compartment that the instance belongs to.
OdaInstance.Builder	connectorUrl(String connectorUrl) URL for the connector’s endpoint.
OdaInstance.Builder	copy(OdaInstance model)
OdaInstance.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Usage of predefined tag keys.
OdaInstance.Builder	description(String description) Description of the Digital Assistant instance.
OdaInstance.Builder	displayName(String displayName) User-defined name for the Digital Assistant instance.
OdaInstance.Builder	freeformTags(Map<String,String> freeformTags) Simple key-value pair that is applied without any predefined name, type, or scope.
OdaInstance.Builder	id(String id) Unique immutable identifier that was assigned when the instance was created.
OdaInstance.Builder	identityAppConsoleUrl(String identityAppConsoleUrl) If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
OdaInstance.Builder	identityAppGuid(String identityAppGuid) If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
OdaInstance.Builder	identityDomain(String identityDomain) If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation.
OdaInstance.Builder	importedPackageIds(List<String> importedPackageIds) A list of package ids imported into this instance (if any).
OdaInstance.Builder	importedPackageNames(List<String> importedPackageNames) A list of package names imported into this instance (if any).
OdaInstance.Builder	isRoleBasedAccess(Boolean isRoleBasedAccess) 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)
OdaInstance.Builder	lifecycleState(OdaInstance.LifecycleState lifecycleState) The current state of the Digital Assistant instance.
OdaInstance.Builder	lifecycleSubState(OdaInstance.LifecycleSubState lifecycleSubState) The current sub-state of the Digital Assistant instance.
OdaInstance.Builder	restrictedOperations(List<RestrictedOperation> restrictedOperations) A list of restricted operations (across all attachments) for this instance (if any).
OdaInstance.Builder	shapeName(OdaInstance.ShapeName shapeName) Shape or size of the instance.
OdaInstance.Builder	stateMessage(String stateMessage) A message that describes the current state in more detail.
OdaInstance.Builder	timeCreated(Date timeCreated) When the Digital Assistant instance was created.
OdaInstance.Builder	timeUpdated(Date timeUpdated) When the Digital Assistance instance was last updated.
OdaInstance.Builder	webAppUrl(String webAppUrl) URL for the Digital Assistant web application that’s associated with the instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public OdaInstance.Builder id(String id)

Unique immutable identifier that was assigned when the instance was created.

Parameters:

id - the value to set

Returns:

this builder

displayName

public OdaInstance.Builder displayName(String displayName)

User-defined name for the Digital Assistant instance. Avoid entering confidential information. You can change this value.

Parameters:

displayName - the value to set

Returns:

this builder

description

public OdaInstance.Builder description(String description)

Description of the Digital Assistant instance.

Parameters:

description - the value to set

Returns:

this builder

compartmentId

public OdaInstance.Builder compartmentId(String compartmentId)

Identifier of the compartment that the instance belongs to.

Parameters:

compartmentId - the value to set

Returns:

this builder

shapeName

public OdaInstance.Builder shapeName(OdaInstance.ShapeName shapeName)

Shape or size of the instance.

Parameters:

shapeName - the value to set

Returns:

this builder

webAppUrl

public OdaInstance.Builder webAppUrl(String webAppUrl)

URL for the Digital Assistant web application that’s associated with the instance.

Parameters:

webAppUrl - the value to set

Returns:

this builder

connectorUrl

public OdaInstance.Builder connectorUrl(String connectorUrl)

URL for the connector’s endpoint.

Parameters:

connectorUrl - the value to set

Returns:

this builder

timeCreated

public OdaInstance.Builder timeCreated(Date timeCreated)

When the Digital Assistant instance was created. A date-time string as described in RFC 3339, section 14.29.

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public OdaInstance.Builder timeUpdated(Date timeUpdated)

When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339, section 14.29.

Parameters:

timeUpdated - the value to set

Returns:

this builder

lifecycleState

public OdaInstance.Builder lifecycleState(OdaInstance.LifecycleState lifecycleState)

The current state of the Digital Assistant instance.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleSubState

public OdaInstance.Builder lifecycleSubState(OdaInstance.LifecycleSubState lifecycleSubState)

The current sub-state of the Digital Assistant instance.

Parameters:

lifecycleSubState - the value to set

Returns:

this builder

stateMessage

public OdaInstance.Builder stateMessage(String stateMessage)

A message that describes the current state in more detail. For example, actionable information about an instance that’s in the FAILED state.

Parameters:

stateMessage - the value to set

Returns:

this builder

freeformTags

public OdaInstance.Builder freeformTags(Map<String,String> freeformTags)

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

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public OdaInstance.Builder definedTags(Map<String,Map<String,Object>> definedTags)

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

Parameters:

definedTags - the value to set

Returns:

this builder

isRoleBasedAccess

public OdaInstance.Builder isRoleBasedAccess(Boolean isRoleBasedAccess)

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)

Parameters:

isRoleBasedAccess - the value to set

Returns:

this builder

identityDomain

public OdaInstance.Builder identityDomain(String identityDomain)

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.

Parameters:

identityDomain - the value to set

Returns:

this builder

identityAppGuid

public OdaInstance.Builder identityAppGuid(String identityAppGuid)

If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.

Parameters:

identityAppGuid - the value to set

Returns:

this builder

identityAppConsoleUrl

public OdaInstance.Builder identityAppConsoleUrl(String identityAppConsoleUrl)

If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.

Parameters:

identityAppConsoleUrl - the value to set

Returns:

this builder

importedPackageNames

public OdaInstance.Builder importedPackageNames(List<String> importedPackageNames)

A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.

Parameters:

importedPackageNames - the value to set

Returns:

this builder

importedPackageIds

public OdaInstance.Builder importedPackageIds(List<String> importedPackageIds)

A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.

Parameters:

importedPackageIds - the value to set

Returns:

this builder

attachmentTypes

public OdaInstance.Builder attachmentTypes(List<String> attachmentTypes)

A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.

Parameters:

attachmentTypes - the value to set

Returns:

this builder

attachmentIds

public OdaInstance.Builder attachmentIds(List<String> attachmentIds)

A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.

Parameters:

attachmentIds - the value to set

Returns:

this builder

restrictedOperations

public OdaInstance.Builder restrictedOperations(List<RestrictedOperation> restrictedOperations)

A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.

Parameters:

restrictedOperations - the value to set

Returns:

this builder

build

public OdaInstance build()

copy

public OdaInstance.Builder copy(OdaInstance model)