com.amazonaws.services.pi.model.GetDimensionKeyDetailsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pi 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.pi.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 GetDimensionKeyDetailsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
*
*/
private String serviceType;
/**
*
* The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an
* Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value.
* For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
*
*/
private String identifier;
/**
*
* The name of the dimension group. Performance Insights searches the specified group for the dimension group ID.
* The following group name values are valid:
*
*
* -
*
* db.query (Amazon DocumentDB only)
*
*
* -
*
* db.sql (Amazon RDS and Aurora only)
*
*
*
*/
private String group;
/**
*
* The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql,
* the group ID is db.sql.id. The following group ID values are valid:
*
*
* -
*
* db.sql.id for dimension group db.sql (Aurora and RDS only)
*
*
* -
*
* db.query.id for dimension group db.query (DocumentDB only)
*
*
*
*/
private String groupIdentifier;
/**
*
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this
* parameter, Performance Insights returns all dimension data within the specified dimension group. Specify
* dimension names for the following dimension groups:
*
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short dimension
* name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the short
* dimension name statement (DocumentDB only).
*
*
*
*/
private java.util.List requestedDimensions;
/**
*
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
*
*
* @param serviceType
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
* @see ServiceType
*/
public void setServiceType(String serviceType) {
this.serviceType = serviceType;
}
/**
*
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
*
*
* @return The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
* @see ServiceType
*/
public String getServiceType() {
return this.serviceType;
}
/**
*
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
*
*
* @param serviceType
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceType
*/
public GetDimensionKeyDetailsRequest withServiceType(String serviceType) {
setServiceType(serviceType);
return this;
}
/**
*
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
*
*
* @param serviceType
* The Amazon Web Services service for which Performance Insights returns data. The only valid value is
* RDS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceType
*/
public GetDimensionKeyDetailsRequest withServiceType(ServiceType serviceType) {
this.serviceType = serviceType.toString();
return this;
}
/**
*
* The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an
* Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value.
* For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
*
*
* @param identifier
* The ID for a data source from which to gather dimension data. This ID must be immutable and unique within
* an Amazon Web Services Region. When a DB instance is the data source, specify its
* DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
*/
public void setIdentifier(String identifier) {
this.identifier = identifier;
}
/**
*
* The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an
* Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value.
* For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
*
*
* @return The ID for a data source from which to gather dimension data. This ID must be immutable and unique within
* an Amazon Web Services Region. When a DB instance is the data source, specify its
* DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
*/
public String getIdentifier() {
return this.identifier;
}
/**
*
* The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an
* Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value.
* For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
*
*
* @param identifier
* The ID for a data source from which to gather dimension data. This ID must be immutable and unique within
* an Amazon Web Services Region. When a DB instance is the data source, specify its
* DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDimensionKeyDetailsRequest withIdentifier(String identifier) {
setIdentifier(identifier);
return this;
}
/**
*
* The name of the dimension group. Performance Insights searches the specified group for the dimension group ID.
* The following group name values are valid:
*
*
* -
*
* db.query (Amazon DocumentDB only)
*
*
* -
*
* db.sql (Amazon RDS and Aurora only)
*
*
*
*
* @param group
* The name of the dimension group. Performance Insights searches the specified group for the dimension group
* ID. The following group name values are valid:
*
* -
*
* db.query (Amazon DocumentDB only)
*
*
* -
*
* db.sql (Amazon RDS and Aurora only)
*
*
*/
public void setGroup(String group) {
this.group = group;
}
/**
*
* The name of the dimension group. Performance Insights searches the specified group for the dimension group ID.
* The following group name values are valid:
*
*
* -
*
* db.query (Amazon DocumentDB only)
*
*
* -
*
* db.sql (Amazon RDS and Aurora only)
*
*
*
*
* @return The name of the dimension group. Performance Insights searches the specified group for the dimension
* group ID. The following group name values are valid:
*
* -
*
* db.query (Amazon DocumentDB only)
*
*
* -
*
* db.sql (Amazon RDS and Aurora only)
*
*
*/
public String getGroup() {
return this.group;
}
/**
*
* The name of the dimension group. Performance Insights searches the specified group for the dimension group ID.
* The following group name values are valid:
*
*
* -
*
* db.query (Amazon DocumentDB only)
*
*
* -
*
* db.sql (Amazon RDS and Aurora only)
*
*
*
*
* @param group
* The name of the dimension group. Performance Insights searches the specified group for the dimension group
* ID. The following group name values are valid:
*
* -
*
* db.query (Amazon DocumentDB only)
*
*
* -
*
* db.sql (Amazon RDS and Aurora only)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDimensionKeyDetailsRequest withGroup(String group) {
setGroup(group);
return this;
}
/**
*
* The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql,
* the group ID is db.sql.id. The following group ID values are valid:
*
*
* -
*
* db.sql.id for dimension group db.sql (Aurora and RDS only)
*
*
* -
*
* db.query.id for dimension group db.query (DocumentDB only)
*
*
*
*
* @param groupIdentifier
* The ID of the dimension group from which to retrieve dimension details. For dimension group
* db.sql, the group ID is db.sql.id. The following group ID values are valid:
*
* -
*
* db.sql.id for dimension group db.sql (Aurora and RDS only)
*
*
* -
*
* db.query.id for dimension group db.query (DocumentDB only)
*
*
*/
public void setGroupIdentifier(String groupIdentifier) {
this.groupIdentifier = groupIdentifier;
}
/**
*
* The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql,
* the group ID is db.sql.id. The following group ID values are valid:
*
*
* -
*
* db.sql.id for dimension group db.sql (Aurora and RDS only)
*
*
* -
*
* db.query.id for dimension group db.query (DocumentDB only)
*
*
*
*
* @return The ID of the dimension group from which to retrieve dimension details. For dimension group
* db.sql, the group ID is db.sql.id. The following group ID values are valid:
*
* -
*
* db.sql.id for dimension group db.sql (Aurora and RDS only)
*
*
* -
*
* db.query.id for dimension group db.query (DocumentDB only)
*
*
*/
public String getGroupIdentifier() {
return this.groupIdentifier;
}
/**
*
* The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql,
* the group ID is db.sql.id. The following group ID values are valid:
*
*
* -
*
* db.sql.id for dimension group db.sql (Aurora and RDS only)
*
*
* -
*
* db.query.id for dimension group db.query (DocumentDB only)
*
*
*
*
* @param groupIdentifier
* The ID of the dimension group from which to retrieve dimension details. For dimension group
* db.sql, the group ID is db.sql.id. The following group ID values are valid:
*
* -
*
* db.sql.id for dimension group db.sql (Aurora and RDS only)
*
*
* -
*
* db.query.id for dimension group db.query (DocumentDB only)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDimensionKeyDetailsRequest withGroupIdentifier(String groupIdentifier) {
setGroupIdentifier(groupIdentifier);
return this;
}
/**
*
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this
* parameter, Performance Insights returns all dimension data within the specified dimension group. Specify
* dimension names for the following dimension groups:
*
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short dimension
* name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the short
* dimension name statement (DocumentDB only).
*
*
*
*
* @return A list of dimensions to retrieve the detail data for within the given dimension group. If you don't
* specify this parameter, Performance Insights returns all dimension data within the specified dimension
* group. Specify dimension names for the following dimension groups:
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short
* dimension name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the
* short dimension name statement (DocumentDB only).
*
*
*/
public java.util.List getRequestedDimensions() {
return requestedDimensions;
}
/**
*
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this
* parameter, Performance Insights returns all dimension data within the specified dimension group. Specify
* dimension names for the following dimension groups:
*
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short dimension
* name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the short
* dimension name statement (DocumentDB only).
*
*
*
*
* @param requestedDimensions
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't
* specify this parameter, Performance Insights returns all dimension data within the specified dimension
* group. Specify dimension names for the following dimension groups:
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short
* dimension name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the
* short dimension name statement (DocumentDB only).
*
*
*/
public void setRequestedDimensions(java.util.Collection requestedDimensions) {
if (requestedDimensions == null) {
this.requestedDimensions = null;
return;
}
this.requestedDimensions = new java.util.ArrayList(requestedDimensions);
}
/**
*
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this
* parameter, Performance Insights returns all dimension data within the specified dimension group. Specify
* dimension names for the following dimension groups:
*
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short dimension
* name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the short
* dimension name statement (DocumentDB only).
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRequestedDimensions(java.util.Collection)} or {@link #withRequestedDimensions(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param requestedDimensions
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't
* specify this parameter, Performance Insights returns all dimension data within the specified dimension
* group. Specify dimension names for the following dimension groups:
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short
* dimension name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the
* short dimension name statement (DocumentDB only).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDimensionKeyDetailsRequest withRequestedDimensions(String... requestedDimensions) {
if (this.requestedDimensions == null) {
setRequestedDimensions(new java.util.ArrayList(requestedDimensions.length));
}
for (String ele : requestedDimensions) {
this.requestedDimensions.add(ele);
}
return this;
}
/**
*
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this
* parameter, Performance Insights returns all dimension data within the specified dimension group. Specify
* dimension names for the following dimension groups:
*
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short dimension
* name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the short
* dimension name statement (DocumentDB only).
*
*
*
*
* @param requestedDimensions
* A list of dimensions to retrieve the detail data for within the given dimension group. If you don't
* specify this parameter, Performance Insights returns all dimension data within the specified dimension
* group. Specify dimension names for the following dimension groups:
*
* -
*
* db.sql - Specify either the full dimension name db.sql.statement or the short
* dimension name statement (Aurora and RDS only).
*
*
* -
*
* db.query - Specify either the full dimension name db.query.statement or the
* short dimension name statement (DocumentDB only).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDimensionKeyDetailsRequest withRequestedDimensions(java.util.Collection requestedDimensions) {
setRequestedDimensions(requestedDimensions);
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 (getServiceType() != null)
sb.append("ServiceType: ").append(getServiceType()).append(",");
if (getIdentifier() != null)
sb.append("Identifier: ").append(getIdentifier()).append(",");
if (getGroup() != null)
sb.append("Group: ").append(getGroup()).append(",");
if (getGroupIdentifier() != null)
sb.append("GroupIdentifier: ").append(getGroupIdentifier()).append(",");
if (getRequestedDimensions() != null)
sb.append("RequestedDimensions: ").append(getRequestedDimensions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetDimensionKeyDetailsRequest == false)
return false;
GetDimensionKeyDetailsRequest other = (GetDimensionKeyDetailsRequest) obj;
if (other.getServiceType() == null ^ this.getServiceType() == null)
return false;
if (other.getServiceType() != null && other.getServiceType().equals(this.getServiceType()) == false)
return false;
if (other.getIdentifier() == null ^ this.getIdentifier() == null)
return false;
if (other.getIdentifier() != null && other.getIdentifier().equals(this.getIdentifier()) == false)
return false;
if (other.getGroup() == null ^ this.getGroup() == null)
return false;
if (other.getGroup() != null && other.getGroup().equals(this.getGroup()) == false)
return false;
if (other.getGroupIdentifier() == null ^ this.getGroupIdentifier() == null)
return false;
if (other.getGroupIdentifier() != null && other.getGroupIdentifier().equals(this.getGroupIdentifier()) == false)
return false;
if (other.getRequestedDimensions() == null ^ this.getRequestedDimensions() == null)
return false;
if (other.getRequestedDimensions() != null && other.getRequestedDimensions().equals(this.getRequestedDimensions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getServiceType() == null) ? 0 : getServiceType().hashCode());
hashCode = prime * hashCode + ((getIdentifier() == null) ? 0 : getIdentifier().hashCode());
hashCode = prime * hashCode + ((getGroup() == null) ? 0 : getGroup().hashCode());
hashCode = prime * hashCode + ((getGroupIdentifier() == null) ? 0 : getGroupIdentifier().hashCode());
hashCode = prime * hashCode + ((getRequestedDimensions() == null) ? 0 : getRequestedDimensions().hashCode());
return hashCode;
}
@Override
public GetDimensionKeyDetailsRequest clone() {
return (GetDimensionKeyDetailsRequest) super.clone();
}
}