java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.xray.model.XRayRequest
    - - software.amazon.awssdk.services.xray.model.CreateGroupRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateGroupRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateGroupRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`filterExpression()`	The filter expression defining criteria by which to group traces.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`groupName()`	The case-sensitive name of the new group.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`InsightsConfiguration`	`insightsConfiguration()`	The structure containing configurations related to insights.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateGroupRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	A map that contains one or more tag keys and tag values to attach to an X-Ray group.
`CreateGroupRequest.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
  - groupName
```
public final String groupName()
```
    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.
  - filterExpression
```
public final String filterExpression()
```
    The filter expression defining criteria by which to group traces.
    
    Returns:
    
    The filter expression defining criteria by which to group traces.
  - insightsConfiguration
```
public final 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.
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<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.
    
    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 hasTags() method.
    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.
  - toBuilder
```
public CreateGroupRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>
    
    Specified by:
    
    toBuilder in class XRayRequest
  - builder
```
public static CreateGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateGroupRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateGroupRequest

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

groupName

filterExpression

insightsConfiguration

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField