StartOutboundVoiceContactRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.connect.model.ConnectRequest
    - - software.amazon.awssdk.services.connect.model.StartOutboundVoiceContactRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartOutboundVoiceContactRequest
extends ConnectRequest
implements ToCopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartOutboundVoiceContactRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartOutboundVoiceContactRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`attributes()` Specify a custom key-value pair using an attribute map.
`static StartOutboundVoiceContactRequest.Builder`	`builder()`
`String`	`clientToken()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`contactFlowId()` The identifier for the contact flow to connect the outbound call to.
`String`	`destinationPhoneNumber()` The phone number of the customer in E.164 format.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`instanceId()` The identifier for your Amazon Connect instance.
`String`	`queueId()` The queue to add the call to.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartOutboundVoiceContactRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourcePhoneNumber()` The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
`StartOutboundVoiceContactRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - destinationPhoneNumber
```
public String destinationPhoneNumber()
```
    The phone number of the customer in E.164 format.
    
    Returns:
    
    The phone number of the customer in E.164 format.
  - contactFlowId
```
public String contactFlowId()
```
    The identifier for the contact flow to connect the outbound call to.
    
    To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.
    
    Returns:
    
    The identifier for the contact flow to connect the outbound call to.
    
    To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.
  - instanceId
```
public String instanceId()
```
    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
    
    Returns:
    
    The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
  - clientToken
```
public String clientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.
  - sourcePhoneNumber
```
public String sourcePhoneNumber()
```
    The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
    
    Returns:
    
    The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
  - queueId
```
public String queueId()
```
    The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow.
    
    To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
    
    Returns:
    
    The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow.
    
    To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
  - attributes
```
public Map<String,String> attributes()
```
    Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
    
    There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.
    
    For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
    
    There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.
    
    For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
  - toBuilder
```
public StartOutboundVoiceContactRequest.Builder 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 interface ToCopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>
    
    Specified by:
    
    toBuilder in class ConnectRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static StartOutboundVoiceContactRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartOutboundVoiceContactRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class StartOutboundVoiceContactRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

destinationPhoneNumber

contactFlowId

instanceId

clientToken

sourcePhoneNumber

queueId

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields