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.StartWebRtcContactRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartWebRtcContactRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AllowedCapabilities`	`allowedCapabilities()`	Information about the video sharing capabilities of the participants (customer, agent).
`Map<String,String>`	`attributes()`	A custom key-value pair using an attribute map.
`static StartWebRtcContactRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`contactFlowId()`	The identifier of the flow for the call.
`String`	`description()`	A description of the task that is shown to an agent in the Contact Control Panel (CCP).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasReferences()`	For responses, this returns true if the service returned a value for the References property.
`String`	`instanceId()`	The identifier of the Amazon Connect instance.
`ParticipantDetails`	`participantDetails()`	Returns the value of the ParticipantDetails property for this object.
`Map<String,Reference>`	`references()`	A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
`String`	`relatedContactId()`	The unique identifier for an Amazon Connect contact.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartWebRtcContactRequest.Builder>`	`serializableBuilderClass()`
`StartWebRtcContactRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

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
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes 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.
  - attributes
```
public final Map<String,String> attributes()
```
    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
    
    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.
    
    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 hasAttributes() method.
    
    Returns:
    
    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
    
    There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.
  - clientToken
```
public final String clientToken()
```
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
    
    Returns:
    
    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
    
    The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
  - contactFlowId
```
public final String contactFlowId()
```
    The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
    
    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
    
    Returns:
    
    The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
    
    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx
  - instanceId
```
public final String instanceId()
```
    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.
  - allowedCapabilities
```
public final AllowedCapabilities allowedCapabilities()
```
    Information about the video sharing capabilities of the participants (customer, agent).
    
    Returns:
    
    Information about the video sharing capabilities of the participants (customer, agent).
  - participantDetails
```
public final ParticipantDetails participantDetails()
```
    Returns the value of the ParticipantDetails property for this object.
    
    Returns:
    
    The value of the ParticipantDetails property for this object.
  - relatedContactId
```
public final String relatedContactId()
```
    The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
    
    Returns:
    
    The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
  - hasReferences
```
public final boolean hasReferences()
```
    For responses, this returns true if the service returned a value for the References 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.
  - references
```
public final Map<String,Reference> references()
```
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
    
    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 hasReferences() method.
    
    Returns:
    
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
  - description
```
public final String description()
```
    A description of the task that is shown to an agent in the Contact Control Panel (CCP).
    
    Returns:
    
    A description of the task that is shown to an agent in the Contact Control Panel (CCP).
  - toBuilder
```
public StartWebRtcContactRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartWebRtcContactRequest.Builder,StartWebRtcContactRequest>
    
    Specified by:
    
    toBuilder in class ConnectRequest
  - builder
```
public static StartWebRtcContactRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartWebRtcContactRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartWebRtcContactRequest

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

hasAttributes

attributes

clientToken

contactFlowId

instanceId

allowedCapabilities

participantDetails

relatedContactId

hasReferences

references

description

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields