com.amazonaws.services.cloudtrail.model.GetChannelResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudtrail 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.cloudtrail.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetChannelResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The ARN of an channel returned by a GetChannel request.
*
*/
private String channelArn;
/**
*
* The name of the CloudTrail channel. For service-linked channels, the name is
* aws-service-channel/service-name/custom-suffix where service-name represents the name
* of the Amazon Web Services service that created the channel and custom-suffix represents the suffix
* generated by the Amazon Web Services service.
*
*/
private String name;
/**
*
* The source for the CloudTrail channel.
*
*/
private String source;
/**
*
* Provides information about the advanced event selectors configured for the channel, and whether the channel
* applies to all Regions or a single Region.
*
*/
private SourceConfig sourceConfig;
/**
*
* The destinations for the channel. For channels created for integrations, the destinations are the event data
* stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon
* Web Services service that created the service-linked channel to receive events.
*
*/
private com.amazonaws.internal.SdkInternalList destinations;
/**
*
* A table showing information about the most recent successful and failed attempts to ingest events.
*
*/
private IngestionStatus ingestionStatus;
/**
*
* The ARN of an channel returned by a GetChannel request.
*
*
* @param channelArn
* The ARN of an channel returned by a GetChannel request.
*/
public void setChannelArn(String channelArn) {
this.channelArn = channelArn;
}
/**
*
* The ARN of an channel returned by a GetChannel request.
*
*
* @return The ARN of an channel returned by a GetChannel request.
*/
public String getChannelArn() {
return this.channelArn;
}
/**
*
* The ARN of an channel returned by a GetChannel request.
*
*
* @param channelArn
* The ARN of an channel returned by a GetChannel request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetChannelResult withChannelArn(String channelArn) {
setChannelArn(channelArn);
return this;
}
/**
*
* The name of the CloudTrail channel. For service-linked channels, the name is
* aws-service-channel/service-name/custom-suffix where service-name represents the name
* of the Amazon Web Services service that created the channel and custom-suffix represents the suffix
* generated by the Amazon Web Services service.
*
*
* @param name
* The name of the CloudTrail channel. For service-linked channels, the name is
* aws-service-channel/service-name/custom-suffix where service-name represents the
* name of the Amazon Web Services service that created the channel and custom-suffix represents
* the suffix generated by the Amazon Web Services service.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the CloudTrail channel. For service-linked channels, the name is
* aws-service-channel/service-name/custom-suffix where service-name represents the name
* of the Amazon Web Services service that created the channel and custom-suffix represents the suffix
* generated by the Amazon Web Services service.
*
*
* @return The name of the CloudTrail channel. For service-linked channels, the name is
* aws-service-channel/service-name/custom-suffix where service-name represents
* the name of the Amazon Web Services service that created the channel and custom-suffix
* represents the suffix generated by the Amazon Web Services service.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the CloudTrail channel. For service-linked channels, the name is
* aws-service-channel/service-name/custom-suffix where service-name represents the name
* of the Amazon Web Services service that created the channel and custom-suffix represents the suffix
* generated by the Amazon Web Services service.
*
*
* @param name
* The name of the CloudTrail channel. For service-linked channels, the name is
* aws-service-channel/service-name/custom-suffix where service-name represents the
* name of the Amazon Web Services service that created the channel and custom-suffix represents
* the suffix generated by the Amazon Web Services service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetChannelResult withName(String name) {
setName(name);
return this;
}
/**
*
* The source for the CloudTrail channel.
*
*
* @param source
* The source for the CloudTrail channel.
*/
public void setSource(String source) {
this.source = source;
}
/**
*
* The source for the CloudTrail channel.
*
*
* @return The source for the CloudTrail channel.
*/
public String getSource() {
return this.source;
}
/**
*
* The source for the CloudTrail channel.
*
*
* @param source
* The source for the CloudTrail channel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetChannelResult withSource(String source) {
setSource(source);
return this;
}
/**
*
* Provides information about the advanced event selectors configured for the channel, and whether the channel
* applies to all Regions or a single Region.
*
*
* @param sourceConfig
* Provides information about the advanced event selectors configured for the channel, and whether the
* channel applies to all Regions or a single Region.
*/
public void setSourceConfig(SourceConfig sourceConfig) {
this.sourceConfig = sourceConfig;
}
/**
*
* Provides information about the advanced event selectors configured for the channel, and whether the channel
* applies to all Regions or a single Region.
*
*
* @return Provides information about the advanced event selectors configured for the channel, and whether the
* channel applies to all Regions or a single Region.
*/
public SourceConfig getSourceConfig() {
return this.sourceConfig;
}
/**
*
* Provides information about the advanced event selectors configured for the channel, and whether the channel
* applies to all Regions or a single Region.
*
*
* @param sourceConfig
* Provides information about the advanced event selectors configured for the channel, and whether the
* channel applies to all Regions or a single Region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetChannelResult withSourceConfig(SourceConfig sourceConfig) {
setSourceConfig(sourceConfig);
return this;
}
/**
*
* The destinations for the channel. For channels created for integrations, the destinations are the event data
* stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon
* Web Services service that created the service-linked channel to receive events.
*
*
* @return The destinations for the channel. For channels created for integrations, the destinations are the event
* data stores that log events arriving through the channel. For service-linked channels, the destination is
* the Amazon Web Services service that created the service-linked channel to receive events.
*/
public java.util.List getDestinations() {
if (destinations == null) {
destinations = new com.amazonaws.internal.SdkInternalList();
}
return destinations;
}
/**
*
* The destinations for the channel. For channels created for integrations, the destinations are the event data
* stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon
* Web Services service that created the service-linked channel to receive events.
*
*
* @param destinations
* The destinations for the channel. For channels created for integrations, the destinations are the event
* data stores that log events arriving through the channel. For service-linked channels, the destination is
* the Amazon Web Services service that created the service-linked channel to receive events.
*/
public void setDestinations(java.util.Collection destinations) {
if (destinations == null) {
this.destinations = null;
return;
}
this.destinations = new com.amazonaws.internal.SdkInternalList(destinations);
}
/**
*
* The destinations for the channel. For channels created for integrations, the destinations are the event data
* stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon
* Web Services service that created the service-linked channel to receive events.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDestinations(java.util.Collection)} or {@link #withDestinations(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param destinations
* The destinations for the channel. For channels created for integrations, the destinations are the event
* data stores that log events arriving through the channel. For service-linked channels, the destination is
* the Amazon Web Services service that created the service-linked channel to receive events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetChannelResult withDestinations(Destination... destinations) {
if (this.destinations == null) {
setDestinations(new com.amazonaws.internal.SdkInternalList(destinations.length));
}
for (Destination ele : destinations) {
this.destinations.add(ele);
}
return this;
}
/**
*
* The destinations for the channel. For channels created for integrations, the destinations are the event data
* stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon
* Web Services service that created the service-linked channel to receive events.
*
*
* @param destinations
* The destinations for the channel. For channels created for integrations, the destinations are the event
* data stores that log events arriving through the channel. For service-linked channels, the destination is
* the Amazon Web Services service that created the service-linked channel to receive events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetChannelResult withDestinations(java.util.Collection destinations) {
setDestinations(destinations);
return this;
}
/**
*
* A table showing information about the most recent successful and failed attempts to ingest events.
*
*
* @param ingestionStatus
* A table showing information about the most recent successful and failed attempts to ingest events.
*/
public void setIngestionStatus(IngestionStatus ingestionStatus) {
this.ingestionStatus = ingestionStatus;
}
/**
*
* A table showing information about the most recent successful and failed attempts to ingest events.
*
*
* @return A table showing information about the most recent successful and failed attempts to ingest events.
*/
public IngestionStatus getIngestionStatus() {
return this.ingestionStatus;
}
/**
*
* A table showing information about the most recent successful and failed attempts to ingest events.
*
*
* @param ingestionStatus
* A table showing information about the most recent successful and failed attempts to ingest events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetChannelResult withIngestionStatus(IngestionStatus ingestionStatus) {
setIngestionStatus(ingestionStatus);
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 (getChannelArn() != null)
sb.append("ChannelArn: ").append(getChannelArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getSourceConfig() != null)
sb.append("SourceConfig: ").append(getSourceConfig()).append(",");
if (getDestinations() != null)
sb.append("Destinations: ").append(getDestinations()).append(",");
if (getIngestionStatus() != null)
sb.append("IngestionStatus: ").append(getIngestionStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetChannelResult == false)
return false;
GetChannelResult other = (GetChannelResult) obj;
if (other.getChannelArn() == null ^ this.getChannelArn() == null)
return false;
if (other.getChannelArn() != null && other.getChannelArn().equals(this.getChannelArn()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getSourceConfig() == null ^ this.getSourceConfig() == null)
return false;
if (other.getSourceConfig() != null && other.getSourceConfig().equals(this.getSourceConfig()) == false)
return false;
if (other.getDestinations() == null ^ this.getDestinations() == null)
return false;
if (other.getDestinations() != null && other.getDestinations().equals(this.getDestinations()) == false)
return false;
if (other.getIngestionStatus() == null ^ this.getIngestionStatus() == null)
return false;
if (other.getIngestionStatus() != null && other.getIngestionStatus().equals(this.getIngestionStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getChannelArn() == null) ? 0 : getChannelArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getSourceConfig() == null) ? 0 : getSourceConfig().hashCode());
hashCode = prime * hashCode + ((getDestinations() == null) ? 0 : getDestinations().hashCode());
hashCode = prime * hashCode + ((getIngestionStatus() == null) ? 0 : getIngestionStatus().hashCode());
return hashCode;
}
@Override
public GetChannelResult clone() {
try {
return (GetChannelResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}