java.lang.Object
- software.amazon.awssdk.services.connect.model.Instance

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Instance.Builder,Instance>

@Generated("software.amazon.awssdk:codegen")
public final class Instance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Instance.Builder,Instance>

The Amazon Connect instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Instance.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the instance.
`static Instance.Builder`	`builder()`
`Instant`	`createdTime()`	When the instance was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`id()`	The identifier of the Amazon Connect instance.
`DirectoryType`	`identityManagementType()`	The identity management type.
`String`	`identityManagementTypeAsString()`	The identity management type.
`Boolean`	`inboundCallsEnabled()`	Whether inbound calls are enabled.
`String`	`instanceAccessUrl()`	This URL allows contact center users to access the Amazon Connect admin website.
`String`	`instanceAlias()`	The alias of instance.
`InstanceStatus`	`instanceStatus()`	The state of the instance.
`String`	`instanceStatusAsString()`	The state of the instance.
`Boolean`	`outboundCallsEnabled()`	Whether outbound calls are enabled.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Instance.Builder>`	`serializableBuilderClass()`
`String`	`serviceRole()`	The service role of the instance.
`InstanceStatusReason`	`statusReason()`	Relevant details why the instance was not successfully created.
`Map<String,String>`	`tags()`	The tags of an instance.
`Instance.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public final String id()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the instance.
  - identityManagementType
```
public final DirectoryType identityManagementType()
```
    The identity management type.
    
    If the service returns an enum value that is not available in the current SDK version, identityManagementType will return DirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityManagementTypeAsString().
    
    Returns:
    
    The identity management type.
    
    See Also:
    
    DirectoryType
  - identityManagementTypeAsString
```
public final String identityManagementTypeAsString()
```
    The identity management type.
    
    If the service returns an enum value that is not available in the current SDK version, identityManagementType will return DirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityManagementTypeAsString().
    
    Returns:
    
    The identity management type.
    
    See Also:
    
    DirectoryType
  - instanceAlias
```
public final String instanceAlias()
```
    The alias of instance.
    
    Returns:
    
    The alias of instance.
  - createdTime
```
public final Instant createdTime()
```
    When the instance was created.
    
    Returns:
    
    When the instance was created.
  - serviceRole
```
public final String serviceRole()
```
    The service role of the instance.
    
    Returns:
    
    The service role of the instance.
  - instanceStatus
```
public final InstanceStatus instanceStatus()
```
    The state of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceStatus will return InstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceStatusAsString().
    
    Returns:
    
    The state of the instance.
    
    See Also:
    
    InstanceStatus
  - instanceStatusAsString
```
public final String instanceStatusAsString()
```
    The state of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceStatus will return InstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceStatusAsString().
    
    Returns:
    
    The state of the instance.
    
    See Also:
    
    InstanceStatus
  - statusReason
```
public final InstanceStatusReason statusReason()
```
    Relevant details why the instance was not successfully created.
    
    Returns:
    
    Relevant details why the instance was not successfully created.
  - inboundCallsEnabled
```
public final Boolean inboundCallsEnabled()
```
    Whether inbound calls are enabled.
    
    Returns:
    
    Whether inbound calls are enabled.
  - outboundCallsEnabled
```
public final Boolean outboundCallsEnabled()
```
    Whether outbound calls are enabled.
    
    Returns:
    
    Whether outbound calls are enabled.
  - instanceAccessUrl
```
public final String instanceAccessUrl()
```
    This URL allows contact center users to access the Amazon Connect admin website.
    
    Returns:
    
    This URL allows contact center users to access the Amazon Connect admin website.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags of an instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags of an instance.
  - toBuilder
```
public Instance.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>
  - builder
```
public static Instance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Instance.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Instance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

arn

identityManagementType

identityManagementTypeAsString

instanceAlias

createdTime

serviceRole

instanceStatus

instanceStatusAsString

statusReason

inboundCallsEnabled

outboundCallsEnabled

instanceAccessUrl

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields