Class Instance
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Instance.Builder,
Instance>
The Amazon Connect instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the instance.static Instance.Builder
builder()
final Instant
When the instance was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The identifier of the Amazon Connect instance.final DirectoryType
The identity management type.final String
The identity management type.final Boolean
Whether inbound calls are enabled.final String
This URL allows contact center users to access the Amazon Connect admin website.final String
The alias of instance.final InstanceStatus
The state of the instance.final String
The state of the instance.final Boolean
Whether outbound calls are enabled.static Class
<? extends Instance.Builder> final String
The service role of the instance.final InstanceStatusReason
Relevant details why the instance was not successfully created.tags()
The tags of an instance.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Resource Name (ARN) of the instance.
- Returns:
- The Amazon Resource Name (ARN) of the instance.
-
identityManagementType
The identity management type.
If the service returns an enum value that is not available in the current SDK version,
identityManagementType
will returnDirectoryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityManagementTypeAsString()
.- Returns:
- The identity management type.
- See Also:
-
identityManagementTypeAsString
The identity management type.
If the service returns an enum value that is not available in the current SDK version,
identityManagementType
will returnDirectoryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidentityManagementTypeAsString()
.- Returns:
- The identity management type.
- See Also:
-
instanceAlias
The alias of instance.
- Returns:
- The alias of instance.
-
createdTime
When the instance was created.
- Returns:
- When the instance was created.
-
serviceRole
The service role of the instance.
- Returns:
- The service role of the instance.
-
instanceStatus
The state of the instance.
If the service returns an enum value that is not available in the current SDK version,
instanceStatus
will returnInstanceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceStatusAsString()
.- Returns:
- The state of the instance.
- See Also:
-
instanceStatusAsString
The state of the instance.
If the service returns an enum value that is not available in the current SDK version,
instanceStatus
will returnInstanceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceStatusAsString()
.- Returns:
- The state of the instance.
- See Also:
-
statusReason
Relevant details why the instance was not successfully created.
- Returns:
- Relevant details why the instance was not successfully created.
-
inboundCallsEnabled
Whether inbound calls are enabled.
- Returns:
- Whether inbound calls are enabled.
-
outboundCallsEnabled
Whether outbound calls are enabled.
- Returns:
- Whether outbound calls are enabled.
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Instance.Builder,
Instance> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-