@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetCurrentMetricDataRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
GetCurrentMetricDataRequest() |
Modifier and Type | Method and Description |
---|---|
GetCurrentMetricDataRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<CurrentMetric> |
getCurrentMetrics()
A list of
CurrentMetric objects for the metrics to retrieve. |
Filters |
getFilters()
A
Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to
use to filter the metrics returned in the response. |
List<String> |
getGroupings()
The grouping applied to the metrics returned.
|
String |
getInstanceId()
The identifier for your Amazon Connect instance.
|
Integer |
getMaxResults()
MaxResults indicates the maximum number of results to return per page in the response, between 1 and
100. |
String |
getNextToken()
The token for the next set of results.
|
int |
hashCode() |
void |
setCurrentMetrics(Collection<CurrentMetric> currentMetrics)
A list of
CurrentMetric objects for the metrics to retrieve. |
void |
setFilters(Filters filters)
A
Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to
use to filter the metrics returned in the response. |
void |
setGroupings(Collection<String> groupings)
The grouping applied to the metrics returned.
|
void |
setInstanceId(String instanceId)
The identifier for your Amazon Connect instance.
|
void |
setMaxResults(Integer maxResults)
MaxResults indicates the maximum number of results to return per page in the response, between 1 and
100. |
void |
setNextToken(String nextToken)
The token for the next set of results.
|
String |
toString()
Returns a string representation of this object.
|
GetCurrentMetricDataRequest |
withCurrentMetrics(Collection<CurrentMetric> currentMetrics)
A list of
CurrentMetric objects for the metrics to retrieve. |
GetCurrentMetricDataRequest |
withCurrentMetrics(CurrentMetric... currentMetrics)
A list of
CurrentMetric objects for the metrics to retrieve. |
GetCurrentMetricDataRequest |
withFilters(Filters filters)
A
Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to
use to filter the metrics returned in the response. |
GetCurrentMetricDataRequest |
withGroupings(Collection<String> groupings)
The grouping applied to the metrics returned.
|
GetCurrentMetricDataRequest |
withGroupings(Grouping... groupings)
The grouping applied to the metrics returned.
|
GetCurrentMetricDataRequest |
withGroupings(String... groupings)
The grouping applied to the metrics returned.
|
GetCurrentMetricDataRequest |
withInstanceId(String instanceId)
The identifier for your Amazon Connect instance.
|
GetCurrentMetricDataRequest |
withMaxResults(Integer maxResults)
MaxResults indicates the maximum number of results to return per page in the response, between 1 and
100. |
GetCurrentMetricDataRequest |
withNextToken(String nextToken)
The token for the next set of results.
|
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 setInstanceId(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.
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.public String getInstanceId()
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.
public GetCurrentMetricDataRequest withInstanceId(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.
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.public void setFilters(Filters filters)
A Filters
object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to
use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated
with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same
request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE
is supported for Channels.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the
queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at
the end of the URL, after 'id=' such as
arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61
. The queue ID is also included in the URL, and is the string after 'queue/'.
filters
- A Filters
object that contains a list of queue IDs or queue ARNs, up to 100, or list of
Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the
resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both
IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each
queue in your instance. Only VOICE is supported for Channels.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN
for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of
characters at the end of the URL, after 'id=' such as
arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61
. The queue ID is also included in the URL, and is the string after 'queue/'.
public Filters getFilters()
A Filters
object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to
use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated
with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same
request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE
is supported for Channels.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the
queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at
the end of the URL, after 'id=' such as
arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61
. The queue ID is also included in the URL, and is the string after 'queue/'.
Filters
object that contains a list of queue IDs or queue ARNs, up to 100, or list of
Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the
resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both
IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each
queue in your instance. Only VOICE is supported for Channels.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN
for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set
of characters at the end of the URL, after 'id=' such as
arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61
. The queue ID is also included in the URL, and is the string after 'queue/'.
public GetCurrentMetricDataRequest withFilters(Filters filters)
A Filters
object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to
use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated
with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same
request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE
is supported for Channels.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the
queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at
the end of the URL, after 'id=' such as
arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61
. The queue ID is also included in the URL, and is the string after 'queue/'.
filters
- A Filters
object that contains a list of queue IDs or queue ARNs, up to 100, or list of
Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the
resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both
IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each
queue in your instance. Only VOICE is supported for Channels.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN
for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of
characters at the end of the URL, after 'id=' such as
arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61
. The queue ID is also included in the URL, and is the string after 'queue/'.
public List<String> getGroupings()
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is returned.
If no Grouping
is included in the request, a summary of CurrentMetrics
is
returned.
Grouping
public void setGroupings(Collection<String> groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is returned.
groupings
- The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned
apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a
Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is
returned.
Grouping
public GetCurrentMetricDataRequest withGroupings(String... groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is returned.
NOTE: This method appends the values to the existing list (if any). Use
setGroupings(java.util.Collection)
or withGroupings(java.util.Collection)
if you want to
override the existing values.
groupings
- The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned
apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a
Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is
returned.
Grouping
public GetCurrentMetricDataRequest withGroupings(Collection<String> groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is returned.
groupings
- The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned
apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a
Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is
returned.
Grouping
public GetCurrentMetricDataRequest withGroupings(Grouping... groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is returned.
groupings
- The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned
apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a
Channels filter. The only supported channel is VOICE.
If no Grouping
is included in the request, a summary of CurrentMetrics
is
returned.
Grouping
public List<CurrentMetric> getCurrentMetrics()
A list of CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data
for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve
data for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
public void setCurrentMetrics(Collection<CurrentMetric> currentMetrics)
A list of CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data
for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
currentMetrics
- A list of CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve
data for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
public GetCurrentMetricDataRequest withCurrentMetrics(CurrentMetric... currentMetrics)
A list of CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data
for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
NOTE: This method appends the values to the existing list (if any). Use
setCurrentMetrics(java.util.Collection)
or withCurrentMetrics(java.util.Collection)
if you want
to override the existing values.
currentMetrics
- A list of CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve
data for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
public GetCurrentMetricDataRequest withCurrentMetrics(Collection<CurrentMetric> currentMetrics)
A list of CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data
for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
currentMetrics
- A list of CurrentMetric
objects for the metrics to retrieve. Each CurrentMetric
includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve
data for in the request.
The following metrics are available:
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: COUNT
Unit: SECONDS
Unit: COUNT
public void setNextToken(String nextToken)
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
nextToken
- The token for the next set of results. Use the value returned in the previous response in the next request
to retrieve the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
public String getNextToken()
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
public GetCurrentMetricDataRequest withNextToken(String nextToken)
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
nextToken
- The token for the next set of results. Use the value returned in the previous response in the next request
to retrieve the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
public void setMaxResults(Integer maxResults)
MaxResults
indicates the maximum number of results to return per page in the response, between 1 and
100.
maxResults
- MaxResults
indicates the maximum number of results to return per page in the response,
between 1 and 100.public Integer getMaxResults()
MaxResults
indicates the maximum number of results to return per page in the response, between 1 and
100.
MaxResults
indicates the maximum number of results to return per page in the response,
between 1 and 100.public GetCurrentMetricDataRequest withMaxResults(Integer maxResults)
MaxResults
indicates the maximum number of results to return per page in the response, between 1 and
100.
maxResults
- MaxResults
indicates the maximum number of results to return per page in the response,
between 1 and 100.public String toString()
toString
in class Object
Object.toString()
public GetCurrentMetricDataRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.