Package com.oracle.bmc.oda.model

Class OdaInstance

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public final class OdaInstance
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Description of OdaServiceInstance object.
    Note: Objects should always be created or deserialized using the OdaInstance.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 OdaInstance.Builder, which maintain a set of all explicitly set fields called OdaInstance.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).

    • Method Detail

      • getId

        public String getId()
        Unique immutable identifier that was assigned when the instance was created.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        User-defined name for the Digital Assistant instance.

        Avoid entering confidential information. You can change this value.

        Returns:
        the value

      • getDescription

        public String getDescription()
        Description of the Digital Assistant instance.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Identifier of the compartment that the instance belongs to.
        Returns:
        the value

      • getShapeName

        public OdaInstance.ShapeName getShapeName()
        Shape or size of the instance.
        Returns:
        the value

      • getWebAppUrl

        public String getWebAppUrl()
        URL for the Digital Assistant web application that’s associated with the instance.
        Returns:
        the value

      • getConnectorUrl

        public String getConnectorUrl()
        URL for the connector’s endpoint.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        When the Digital Assistant instance was created.

        A date-time string as described in RFC 3339, section 14.29.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        When the Digital Assistance instance was last updated.

        A date-time string as described in RFC 3339, section 14.29.

        Returns:
        the value

      • getLifecycleState

        public OdaInstance.LifecycleState getLifecycleState()
        The current state of the Digital Assistant instance.
        Returns:
        the value

      • getLifecycleSubState

        public OdaInstance.LifecycleSubState getLifecycleSubState()
        The current sub-state of the Digital Assistant instance.
        Returns:
        the value

      • getStateMessage

        public String getStateMessage()
        A message that describes the current state in more detail.

        For example, actionable information about an instance that’s 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.

        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

      • getIdentityAppGuid

        public String getIdentityAppGuid()
        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.

        Returns:
        the value

      • getIdentityAppConsoleUrl

        public String getIdentityAppConsoleUrl()
        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.
        Returns:
        the value

      • getImportedPackageNames

        public List<String> getImportedPackageNames()
        A list of package names imported into this instance (if any).

        Use importedPackageIds field to get the details of the imported packages.

        Returns:
        the value

      • getImportedPackageIds

        public List<String> getImportedPackageIds()
        A list of package ids imported into this instance (if any).

        Use GetImportedPackage to get the details of the imported packages.

        Returns:
        the value

      • getAttachmentTypes

        public List<String> getAttachmentTypes()
        A list of attachment types for this instance (if any).

        Use attachmentIds to get the details of the attachments.

        Returns:
        the value

      • getAttachmentIds

        public List<String> getAttachmentIds()
        A list of attachment identifiers for this instance (if any).

        Use GetOdaInstanceAttachment to get the details of the attachments.

        Returns:
        the value

      • getRestrictedOperations

        public List<RestrictedOperation> getRestrictedOperations()
        A list of restricted operations (across all attachments) for this instance (if any).

        Use GetOdaInstanceAttachment to get the details of the attachments.

        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