com.amazonaws.services.eventbridge.model.PutEventsResultEntry Maven / Gradle / Ivy
Show all versions of aws-java-sdk-eventbridge Show documentation
/*
* Copyright 2019-2024 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.eventbridge.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Represents the results of an event submitted to an event bus.
*
*
* If the submission was successful, the entry has the event ID in it. Otherwise, you can use the error code and error
* message to identify the problem with the entry.
*
*
* For information about the errors that are common to all actions, see Common Errors.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutEventsResultEntry implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID of the event.
*
*/
private String eventId;
/**
*
* The error code that indicates why the event submission failed.
*
*
* Retryable errors include:
*
*
* -
*
* InternalFailure
*
*
* The request processing has failed because of an unknown error, exception or failure.
*
*
* -
*
*
* The request was denied due to request throttling.
*
*
*
*
* Non-retryable errors include:
*
*
* -
*
*
* You do not have sufficient access to perform this action.
*
*
* -
*
* InvalidAccountIdException
*
*
* The account ID provided is not valid.
*
*
* -
*
* InvalidArgument
*
*
* A specified parameter is not valid.
*
*
* -
*
* MalformedDetail
*
*
* The JSON provided is not valid.
*
*
* -
*
* RedactionFailure
*
*
* Redacting the CloudTrail event failed.
*
*
* -
*
* NotAuthorizedForSourceException
*
*
* You do not have permissions to publish events with this source onto this event bus.
*
*
* -
*
* NotAuthorizedForDetailTypeException
*
*
* You do not have permissions to publish events with this detail type onto this event bus.
*
*
*
*/
private String errorCode;
/**
*
* The error message that explains why the event submission failed.
*
*/
private String errorMessage;
/**
*
* The ID of the event.
*
*
* @param eventId
* The ID of the event.
*/
public void setEventId(String eventId) {
this.eventId = eventId;
}
/**
*
* The ID of the event.
*
*
* @return The ID of the event.
*/
public String getEventId() {
return this.eventId;
}
/**
*
* The ID of the event.
*
*
* @param eventId
* The ID of the event.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsResultEntry withEventId(String eventId) {
setEventId(eventId);
return this;
}
/**
*
* The error code that indicates why the event submission failed.
*
*
* Retryable errors include:
*
*
* -
*
* InternalFailure
*
*
* The request processing has failed because of an unknown error, exception or failure.
*
*
* -
*
*
* The request was denied due to request throttling.
*
*
*
*
* Non-retryable errors include:
*
*
* -
*
*
* You do not have sufficient access to perform this action.
*
*
* -
*
* InvalidAccountIdException
*
*
* The account ID provided is not valid.
*
*
* -
*
* InvalidArgument
*
*
* A specified parameter is not valid.
*
*
* -
*
* MalformedDetail
*
*
* The JSON provided is not valid.
*
*
* -
*
* RedactionFailure
*
*
* Redacting the CloudTrail event failed.
*
*
* -
*
* NotAuthorizedForSourceException
*
*
* You do not have permissions to publish events with this source onto this event bus.
*
*
* -
*
* NotAuthorizedForDetailTypeException
*
*
* You do not have permissions to publish events with this detail type onto this event bus.
*
*
*
*
* @param errorCode
* The error code that indicates why the event submission failed.
*
* Retryable errors include:
*
*
* -
*
* InternalFailure
*
*
* The request processing has failed because of an unknown error, exception or failure.
*
*
* -
*
*
* The request was denied due to request throttling.
*
*
*
*
* Non-retryable errors include:
*
*
* -
*
*
* You do not have sufficient access to perform this action.
*
*
* -
*
* InvalidAccountIdException
*
*
* The account ID provided is not valid.
*
*
* -
*
* InvalidArgument
*
*
* A specified parameter is not valid.
*
*
* -
*
* MalformedDetail
*
*
* The JSON provided is not valid.
*
*
* -
*
* RedactionFailure
*
*
* Redacting the CloudTrail event failed.
*
*
* -
*
* NotAuthorizedForSourceException
*
*
* You do not have permissions to publish events with this source onto this event bus.
*
*
* -
*
* NotAuthorizedForDetailTypeException
*
*
* You do not have permissions to publish events with this detail type onto this event bus.
*
*
*/
public void setErrorCode(String errorCode) {
this.errorCode = errorCode;
}
/**
*
* The error code that indicates why the event submission failed.
*
*
* Retryable errors include:
*
*
* -
*
* InternalFailure
*
*
* The request processing has failed because of an unknown error, exception or failure.
*
*
* -
*
*
* The request was denied due to request throttling.
*
*
*
*
* Non-retryable errors include:
*
*
* -
*
*
* You do not have sufficient access to perform this action.
*
*
* -
*
* InvalidAccountIdException
*
*
* The account ID provided is not valid.
*
*
* -
*
* InvalidArgument
*
*
* A specified parameter is not valid.
*
*
* -
*
* MalformedDetail
*
*
* The JSON provided is not valid.
*
*
* -
*
* RedactionFailure
*
*
* Redacting the CloudTrail event failed.
*
*
* -
*
* NotAuthorizedForSourceException
*
*
* You do not have permissions to publish events with this source onto this event bus.
*
*
* -
*
* NotAuthorizedForDetailTypeException
*
*
* You do not have permissions to publish events with this detail type onto this event bus.
*
*
*
*
* @return The error code that indicates why the event submission failed.
*
* Retryable errors include:
*
*
* -
*
* InternalFailure
*
*
* The request processing has failed because of an unknown error, exception or failure.
*
*
* -
*
*
* The request was denied due to request throttling.
*
*
*
*
* Non-retryable errors include:
*
*
* -
*
*
* You do not have sufficient access to perform this action.
*
*
* -
*
* InvalidAccountIdException
*
*
* The account ID provided is not valid.
*
*
* -
*
* InvalidArgument
*
*
* A specified parameter is not valid.
*
*
* -
*
* MalformedDetail
*
*
* The JSON provided is not valid.
*
*
* -
*
* RedactionFailure
*
*
* Redacting the CloudTrail event failed.
*
*
* -
*
* NotAuthorizedForSourceException
*
*
* You do not have permissions to publish events with this source onto this event bus.
*
*
* -
*
* NotAuthorizedForDetailTypeException
*
*
* You do not have permissions to publish events with this detail type onto this event bus.
*
*
*/
public String getErrorCode() {
return this.errorCode;
}
/**
*
* The error code that indicates why the event submission failed.
*
*
* Retryable errors include:
*
*
* -
*
* InternalFailure
*
*
* The request processing has failed because of an unknown error, exception or failure.
*
*
* -
*
*
* The request was denied due to request throttling.
*
*
*
*
* Non-retryable errors include:
*
*
* -
*
*
* You do not have sufficient access to perform this action.
*
*
* -
*
* InvalidAccountIdException
*
*
* The account ID provided is not valid.
*
*
* -
*
* InvalidArgument
*
*
* A specified parameter is not valid.
*
*
* -
*
* MalformedDetail
*
*
* The JSON provided is not valid.
*
*
* -
*
* RedactionFailure
*
*
* Redacting the CloudTrail event failed.
*
*
* -
*
* NotAuthorizedForSourceException
*
*
* You do not have permissions to publish events with this source onto this event bus.
*
*
* -
*
* NotAuthorizedForDetailTypeException
*
*
* You do not have permissions to publish events with this detail type onto this event bus.
*
*
*
*
* @param errorCode
* The error code that indicates why the event submission failed.
*
* Retryable errors include:
*
*
* -
*
* InternalFailure
*
*
* The request processing has failed because of an unknown error, exception or failure.
*
*
* -
*
*
* The request was denied due to request throttling.
*
*
*
*
* Non-retryable errors include:
*
*
* -
*
*
* You do not have sufficient access to perform this action.
*
*
* -
*
* InvalidAccountIdException
*
*
* The account ID provided is not valid.
*
*
* -
*
* InvalidArgument
*
*
* A specified parameter is not valid.
*
*
* -
*
* MalformedDetail
*
*
* The JSON provided is not valid.
*
*
* -
*
* RedactionFailure
*
*
* Redacting the CloudTrail event failed.
*
*
* -
*
* NotAuthorizedForSourceException
*
*
* You do not have permissions to publish events with this source onto this event bus.
*
*
* -
*
* NotAuthorizedForDetailTypeException
*
*
* You do not have permissions to publish events with this detail type onto this event bus.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsResultEntry withErrorCode(String errorCode) {
setErrorCode(errorCode);
return this;
}
/**
*
* The error message that explains why the event submission failed.
*
*
* @param errorMessage
* The error message that explains why the event submission failed.
*/
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
/**
*
* The error message that explains why the event submission failed.
*
*
* @return The error message that explains why the event submission failed.
*/
public String getErrorMessage() {
return this.errorMessage;
}
/**
*
* The error message that explains why the event submission failed.
*
*
* @param errorMessage
* The error message that explains why the event submission failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsResultEntry withErrorMessage(String errorMessage) {
setErrorMessage(errorMessage);
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 (getEventId() != null)
sb.append("EventId: ").append(getEventId()).append(",");
if (getErrorCode() != null)
sb.append("ErrorCode: ").append(getErrorCode()).append(",");
if (getErrorMessage() != null)
sb.append("ErrorMessage: ").append(getErrorMessage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutEventsResultEntry == false)
return false;
PutEventsResultEntry other = (PutEventsResultEntry) obj;
if (other.getEventId() == null ^ this.getEventId() == null)
return false;
if (other.getEventId() != null && other.getEventId().equals(this.getEventId()) == false)
return false;
if (other.getErrorCode() == null ^ this.getErrorCode() == null)
return false;
if (other.getErrorCode() != null && other.getErrorCode().equals(this.getErrorCode()) == false)
return false;
if (other.getErrorMessage() == null ^ this.getErrorMessage() == null)
return false;
if (other.getErrorMessage() != null && other.getErrorMessage().equals(this.getErrorMessage()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEventId() == null) ? 0 : getEventId().hashCode());
hashCode = prime * hashCode + ((getErrorCode() == null) ? 0 : getErrorCode().hashCode());
hashCode = prime * hashCode + ((getErrorMessage() == null) ? 0 : getErrorMessage().hashCode());
return hashCode;
}
@Override
public PutEventsResultEntry clone() {
try {
return (PutEventsResultEntry) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.eventbridge.model.transform.PutEventsResultEntryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}