com.amazonaws.services.xray.model.CreateGroupRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-xray Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.xray.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateGroupRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*
*/
private String groupName;
/**
*
* The filter expression defining criteria by which to group traces.
*
*/
private String filterExpression;
/**
*
* 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.
*
*
*
*/
private InsightsConfiguration insightsConfiguration;
/**
*
* 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.
*
*
*
*/
private java.util.List tags;
/**
*
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*
*
* @param groupName
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*/
public void setGroupName(String groupName) {
this.groupName = groupName;
}
/**
*
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*
*
* @return The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*/
public String getGroupName() {
return this.groupName;
}
/**
*
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
*
*
* @param groupName
* The case-sensitive name of the new group. Default is a reserved name and names must be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGroupRequest withGroupName(String groupName) {
setGroupName(groupName);
return this;
}
/**
*
* The filter expression defining criteria by which to group traces.
*
*
* @param filterExpression
* The filter expression defining criteria by which to group traces.
*/
public void setFilterExpression(String filterExpression) {
this.filterExpression = filterExpression;
}
/**
*
* The filter expression defining criteria by which to group traces.
*
*
* @return The filter expression defining criteria by which to group traces.
*/
public String getFilterExpression() {
return this.filterExpression;
}
/**
*
* The filter expression defining criteria by which to group traces.
*
*
* @param filterExpression
* The filter expression defining criteria by which to group traces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGroupRequest withFilterExpression(String filterExpression) {
setFilterExpression(filterExpression);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setInsightsConfiguration(InsightsConfiguration insightsConfiguration) {
this.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.
*
*
*
*
* @return 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.
*
*
*/
public InsightsConfiguration getInsightsConfiguration() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGroupRequest withInsightsConfiguration(InsightsConfiguration insightsConfiguration) {
setInsightsConfiguration(insightsConfiguration);
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public java.util.List getTags() {
return 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.
*
*
*
*
* @param 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.
*
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(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
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGroupRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateGroupRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getGroupName() != null)
sb.append("GroupName: ").append(getGroupName()).append(",");
if (getFilterExpression() != null)
sb.append("FilterExpression: ").append(getFilterExpression()).append(",");
if (getInsightsConfiguration() != null)
sb.append("InsightsConfiguration: ").append(getInsightsConfiguration()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateGroupRequest == false)
return false;
CreateGroupRequest other = (CreateGroupRequest) obj;
if (other.getGroupName() == null ^ this.getGroupName() == null)
return false;
if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == false)
return false;
if (other.getFilterExpression() == null ^ this.getFilterExpression() == null)
return false;
if (other.getFilterExpression() != null && other.getFilterExpression().equals(this.getFilterExpression()) == false)
return false;
if (other.getInsightsConfiguration() == null ^ this.getInsightsConfiguration() == null)
return false;
if (other.getInsightsConfiguration() != null && other.getInsightsConfiguration().equals(this.getInsightsConfiguration()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode());
hashCode = prime * hashCode + ((getFilterExpression() == null) ? 0 : getFilterExpression().hashCode());
hashCode = prime * hashCode + ((getInsightsConfiguration() == null) ? 0 : getInsightsConfiguration().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateGroupRequest clone() {
return (CreateGroupRequest) super.clone();
}
}