@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PostContentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, SignerTypeAware
NOOP
Constructor and Description |
---|
PostContentRequest() |
Modifier and Type | Method and Description |
---|---|
PostContentRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAccept()
You pass this value as the
Accept HTTP header. |
String |
getBotAlias()
Alias of the Amazon Lex bot.
|
String |
getBotName()
Name of the Amazon Lex bot.
|
String |
getContentType()
You pass this value as the
Content-Type HTTP header. |
InputStream |
getInputStream()
User input in PCM or Opus audio format or text format as described in the
Content-Type HTTP header. |
String |
getRequestAttributes()
You pass this value as the
x-amz-lex-request-attributes HTTP header. |
String |
getSessionAttributes()
You pass this value as the
x-amz-lex-session-attributes HTTP header. |
String |
getSignerType() |
String |
getUserId()
The ID of the client application user.
|
int |
hashCode() |
void |
setAccept(String accept)
You pass this value as the
Accept HTTP header. |
void |
setBotAlias(String botAlias)
Alias of the Amazon Lex bot.
|
void |
setBotName(String botName)
Name of the Amazon Lex bot.
|
void |
setContentType(String contentType)
You pass this value as the
Content-Type HTTP header. |
void |
setInputStream(InputStream inputStream)
User input in PCM or Opus audio format or text format as described in the
Content-Type HTTP header. |
void |
setRequestAttributes(String requestAttributes)
You pass this value as the
x-amz-lex-request-attributes HTTP header. |
void |
setSessionAttributes(String sessionAttributes)
You pass this value as the
x-amz-lex-session-attributes HTTP header. |
void |
setUserId(String userId)
The ID of the client application user.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
PostContentRequest |
withAccept(String accept)
You pass this value as the
Accept HTTP header. |
PostContentRequest |
withBotAlias(String botAlias)
Alias of the Amazon Lex bot.
|
PostContentRequest |
withBotName(String botName)
Name of the Amazon Lex bot.
|
PostContentRequest |
withContentType(String contentType)
You pass this value as the
Content-Type HTTP header. |
PostContentRequest |
withInputStream(InputStream inputStream)
User input in PCM or Opus audio format or text format as described in the
Content-Type HTTP header. |
PostContentRequest |
withRequestAttributes(String requestAttributes)
You pass this value as the
x-amz-lex-request-attributes HTTP header. |
PostContentRequest |
withSessionAttributes(String sessionAttributes)
You pass this value as the
x-amz-lex-session-attributes HTTP header. |
PostContentRequest |
withUserId(String userId)
The ID of the client application user.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setBotName(String botName)
Name of the Amazon Lex bot.
botName
- Name of the Amazon Lex bot.public String getBotName()
Name of the Amazon Lex bot.
public PostContentRequest withBotName(String botName)
Name of the Amazon Lex bot.
botName
- Name of the Amazon Lex bot.public void setBotAlias(String botAlias)
Alias of the Amazon Lex bot.
botAlias
- Alias of the Amazon Lex bot.public String getBotAlias()
Alias of the Amazon Lex bot.
public PostContentRequest withBotAlias(String botAlias)
Alias of the Amazon Lex bot.
botAlias
- Alias of the Amazon Lex bot.public void setUserId(String userId)
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At
runtime, each request must contain the userID
field.
To decide the user ID to use for your application, consider the following factors.
The userID
field must not contain any personally identifiable information of the user, for example,
name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
userId
- The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your
bot. At runtime, each request must contain the userID
field.
To decide the user ID to use for your application, consider the following factors.
The userID
field must not contain any personally identifiable information of the user, for
example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
public String getUserId()
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At
runtime, each request must contain the userID
field.
To decide the user ID to use for your application, consider the following factors.
The userID
field must not contain any personally identifiable information of the user, for example,
name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
userID
field.
To decide the user ID to use for your application, consider the following factors.
The userID
field must not contain any personally identifiable information of the user, for
example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
public PostContentRequest withUserId(String userId)
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At
runtime, each request must contain the userID
field.
To decide the user ID to use for your application, consider the following factors.
The userID
field must not contain any personally identifiable information of the user, for example,
name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
userId
- The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your
bot. At runtime, each request must contain the userID
field.
To decide the user ID to use for your application, consider the following factors.
The userID
field must not contain any personally identifiable information of the user, for
example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
public void setSessionAttributes(String sessionAttributes)
You pass this value as the x-amz-lex-session-attributes
HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes
and requestAttributes
headers is limited to 12 KB.
For more information, see Setting Session Attributes.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
sessionAttributes
- You pass this value as the x-amz-lex-session-attributes
HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a
JSON serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes
and requestAttributes
headers is limited to 12 KB.
For more information, see Setting Session Attributes.
public String getSessionAttributes()
You pass this value as the x-amz-lex-session-attributes
HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes
and requestAttributes
headers is limited to 12 KB.
For more information, see Setting Session Attributes.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
x-amz-lex-session-attributes
HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a
JSON serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes
and requestAttributes
headers is limited to 12 KB.
For more information, see Setting Session Attributes.
public PostContentRequest withSessionAttributes(String sessionAttributes)
You pass this value as the x-amz-lex-session-attributes
HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes
and requestAttributes
headers is limited to 12 KB.
For more information, see Setting Session Attributes.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
sessionAttributes
- You pass this value as the x-amz-lex-session-attributes
HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a
JSON serialized and base64 encoded map with string keys and values. The total size of the
sessionAttributes
and requestAttributes
headers is limited to 12 KB.
For more information, see Setting Session Attributes.
public void setRequestAttributes(String requestAttributes)
You pass this value as the x-amz-lex-request-attributes
HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes
and sessionAttributes
headers is limited to 12 KB.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes
with the prefix x-amz-lex:
.
For more information, see Setting Request Attributes.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
requestAttributes
- You pass this value as the x-amz-lex-request-attributes
HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes
and sessionAttributes
headers is limited to 12 KB.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request
attributes with the prefix x-amz-lex:
.
For more information, see Setting Request Attributes.
public String getRequestAttributes()
You pass this value as the x-amz-lex-request-attributes
HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes
and sessionAttributes
headers is limited to 12 KB.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes
with the prefix x-amz-lex:
.
For more information, see Setting Request Attributes.
This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
x-amz-lex-request-attributes
HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes
and sessionAttributes
headers is limited to 12 KB.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request
attributes with the prefix x-amz-lex:
.
For more information, see Setting Request Attributes.
public PostContentRequest withRequestAttributes(String requestAttributes)
You pass this value as the x-amz-lex-request-attributes
HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes
and sessionAttributes
headers is limited to 12 KB.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request attributes
with the prefix x-amz-lex:
.
For more information, see Setting Request Attributes.
This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
requestAttributes
- You pass this value as the x-amz-lex-request-attributes
HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
serialized and base64 encoded map with string keys and values. The total size of the
requestAttributes
and sessionAttributes
headers is limited to 12 KB.
The namespace x-amz-lex:
is reserved for special attributes. Don't create any request
attributes with the prefix x-amz-lex:
.
For more information, see Setting Request Attributes.
public void setContentType(String contentType)
You pass this value as the Content-Type
HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
contentType
- You pass this value as the Content-Type
HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
public String getContentType()
You pass this value as the Content-Type
HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
Content-Type
HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
public PostContentRequest withContentType(String contentType)
You pass this value as the Content-Type
HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
contentType
- You pass this value as the Content-Type
HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
public void setAccept(String accept)
You pass this value as the Accept
HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the Accept
HTTP
header value in the request.
If the value is text/plain; charset=utf-8
, Amazon Lex returns text in the response.
If the value begins with audio/
, Amazon Lex returns speech in the response. Amazon Lex uses Amazon
Polly to generate the speech (using the configuration you specified in the Accept
header). For
example, if you specify audio/mpeg
as the value, Amazon Lex returns speech in the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
accept
- You pass this value as the Accept
HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the
Accept
HTTP header value in the request.
If the value is text/plain; charset=utf-8
, Amazon Lex returns text in the response.
If the value begins with audio/
, Amazon Lex returns speech in the response. Amazon Lex uses
Amazon Polly to generate the speech (using the configuration you specified in the Accept
header). For example, if you specify audio/mpeg
as the value, Amazon Lex returns speech in
the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
public String getAccept()
You pass this value as the Accept
HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the Accept
HTTP
header value in the request.
If the value is text/plain; charset=utf-8
, Amazon Lex returns text in the response.
If the value begins with audio/
, Amazon Lex returns speech in the response. Amazon Lex uses Amazon
Polly to generate the speech (using the configuration you specified in the Accept
header). For
example, if you specify audio/mpeg
as the value, Amazon Lex returns speech in the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
Accept
HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the
Accept
HTTP header value in the request.
If the value is text/plain; charset=utf-8
, Amazon Lex returns text in the response.
If the value begins with audio/
, Amazon Lex returns speech in the response. Amazon Lex uses
Amazon Polly to generate the speech (using the configuration you specified in the Accept
header). For example, if you specify audio/mpeg
as the value, Amazon Lex returns speech in
the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
public PostContentRequest withAccept(String accept)
You pass this value as the Accept
HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the Accept
HTTP
header value in the request.
If the value is text/plain; charset=utf-8
, Amazon Lex returns text in the response.
If the value begins with audio/
, Amazon Lex returns speech in the response. Amazon Lex uses Amazon
Polly to generate the speech (using the configuration you specified in the Accept
header). For
example, if you specify audio/mpeg
as the value, Amazon Lex returns speech in the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
accept
- You pass this value as the Accept
HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the
Accept
HTTP header value in the request.
If the value is text/plain; charset=utf-8
, Amazon Lex returns text in the response.
If the value begins with audio/
, Amazon Lex returns speech in the response. Amazon Lex uses
Amazon Polly to generate the speech (using the configuration you specified in the Accept
header). For example, if you specify audio/mpeg
as the value, Amazon Lex returns speech in
the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
public void setInputStream(InputStream inputStream)
User input in PCM or Opus audio format or text format as described in the Content-Type
HTTP header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
inputStream
- User input in PCM or Opus audio format or text format as described in the Content-Type
HTTP
header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
public InputStream getInputStream()
User input in PCM or Opus audio format or text format as described in the Content-Type
HTTP header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
Content-Type
HTTP
header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
public PostContentRequest withInputStream(InputStream inputStream)
User input in PCM or Opus audio format or text format as described in the Content-Type
HTTP header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
inputStream
- User input in PCM or Opus audio format or text format as described in the Content-Type
HTTP
header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
public String toString()
toString
in class Object
Object.toString()
public PostContentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
public String getSignerType()
getSignerType
in interface SignerTypeAware
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.