com.amazonaws.services.xray.model

Class CreateGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.xray.model.CreateGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateGroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getFilterExpression() The filter expression defining criteria by which to group traces.
String	getGroupName() The case-sensitive name of the new group.
InsightsConfiguration	getInsightsConfiguration() The structure containing configurations related to insights.
List<Tag>	getTags() A map that contains one or more tag keys and tag values to attach to an X-Ray group.
int	hashCode()
void	setFilterExpression(String filterExpression) The filter expression defining criteria by which to group traces.
void	setGroupName(String groupName) The case-sensitive name of the new group.
void	setInsightsConfiguration(InsightsConfiguration insightsConfiguration) The structure containing configurations related to insights.
void	setTags(Collection<Tag> tags) A map that contains one or more tag keys and tag values to attach to an X-Ray group.
String	toString() Returns a string representation of this object.
CreateGroupRequest	withFilterExpression(String filterExpression) The filter expression defining criteria by which to group traces.
CreateGroupRequest	withGroupName(String groupName) The case-sensitive name of the new group.
CreateGroupRequest	withInsightsConfiguration(InsightsConfiguration insightsConfiguration) The structure containing configurations related to insights.
CreateGroupRequest	withTags(Collection<Tag> tags) A map that contains one or more tag keys and tag values to attach to an X-Ray group.
CreateGroupRequest	withTags(Tag... tags) A map that contains one or more tag keys and tag values to attach to an X-Ray group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGroupRequest

public CreateGroupRequest()

Method Detail

setGroupName

public void setGroupName(String groupName)

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Parameters:

groupName - The case-sensitive name of the new group. Default is a reserved name and names must be unique.

getGroupName

public String getGroupName()

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Returns:

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

withGroupName

public CreateGroupRequest withGroupName(String groupName)

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Parameters:

groupName - The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilterExpression

public void setFilterExpression(String filterExpression)

The filter expression defining criteria by which to group traces.

Parameters:

filterExpression - The filter expression defining criteria by which to group traces.

getFilterExpression

public String getFilterExpression()

The filter expression defining criteria by which to group traces.

Returns:

The filter expression defining criteria by which to group traces.

withFilterExpression

public CreateGroupRequest withFilterExpression(String filterExpression)

The filter expression defining criteria by which to group traces.

Parameters:

filterExpression - The filter expression defining criteria by which to group traces.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInsightsConfiguration

public void setInsightsConfiguration(InsightsConfiguration insightsConfiguration)

The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

Parameters:

insightsConfiguration - The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

getInsightsConfiguration

public InsightsConfiguration getInsightsConfiguration()

The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

Returns:

The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

withInsightsConfiguration

public CreateGroupRequest withInsightsConfiguration(InsightsConfiguration insightsConfiguration)

The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

Parameters:

insightsConfiguration - The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Returns:

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

setTags

public void setTags(Collection<Tag> tags)

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Parameters:

tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

withTags

public CreateGroupRequest withTags(Tag... tags)

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateGroupRequest withTags(Collection<Tag> tags)

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Parameters:

tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()