com.amazonaws.services.eventbridge.model.PutEventsRequestEntry 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 an event to be submitted.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutEventsRequestEntry implements Serializable, Cloneable, StructuredPojo {
/**
*
* The time stamp of the event, per RFC3339. If no time
* stamp is provided, the time stamp of the PutEvents call is used.
*
*/
private java.util.Date time;
/**
*
* The source of the event.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*/
private String source;
/**
*
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any
* number, including zero, may be present.
*
*/
private java.util.List resources;
/**
*
* Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*/
private String detailType;
/**
*
* A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*/
private String detail;
/**
*
* The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are
* used to match the event. If you omit this, the default event bus is used.
*
*
*
* If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN)
* of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding
* event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the
* event bus ARN is preferred.
*
*
*/
private String eventBusName;
/**
*
* An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the
* event.
*
*
* To learn more about X-Ray trace headers, see Tracing
* header in the X-Ray Developer Guide.
*
*/
private String traceHeader;
/**
*
* The time stamp of the event, per RFC3339. If no time
* stamp is provided, the time stamp of the PutEvents call is used.
*
*
* @param time
* The time stamp of the event, per RFC3339. If no
* time stamp is provided, the time stamp of the PutEvents call
* is used.
*/
public void setTime(java.util.Date time) {
this.time = time;
}
/**
*
* The time stamp of the event, per RFC3339. If no time
* stamp is provided, the time stamp of the PutEvents call is used.
*
*
* @return The time stamp of the event, per RFC3339. If no
* time stamp is provided, the time stamp of the PutEvents call
* is used.
*/
public java.util.Date getTime() {
return this.time;
}
/**
*
* The time stamp of the event, per RFC3339. If no time
* stamp is provided, the time stamp of the PutEvents call is used.
*
*
* @param time
* The time stamp of the event, per RFC3339. If no
* time stamp is provided, the time stamp of the PutEvents call
* is used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withTime(java.util.Date time) {
setTime(time);
return this;
}
/**
*
* The source of the event.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @param source
* The source of the event.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
*/
public void setSource(String source) {
this.source = source;
}
/**
*
* The source of the event.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @return The source of the event.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
*/
public String getSource() {
return this.source;
}
/**
*
* The source of the event.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @param source
* The source of the event.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withSource(String source) {
setSource(source);
return this;
}
/**
*
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any
* number, including zero, may be present.
*
*
* @return Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
* concerns. Any number, including zero, may be present.
*/
public java.util.List getResources() {
return resources;
}
/**
*
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any
* number, including zero, may be present.
*
*
* @param resources
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
* concerns. Any number, including zero, may be present.
*/
public void setResources(java.util.Collection resources) {
if (resources == null) {
this.resources = null;
return;
}
this.resources = new java.util.ArrayList(resources);
}
/**
*
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any
* number, including zero, may be present.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResources(java.util.Collection)} or {@link #withResources(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param resources
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
* concerns. Any number, including zero, may be present.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withResources(String... resources) {
if (this.resources == null) {
setResources(new java.util.ArrayList(resources.length));
}
for (String ele : resources) {
this.resources.add(ele);
}
return this;
}
/**
*
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any
* number, including zero, may be present.
*
*
* @param resources
* Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
* concerns. Any number, including zero, may be present.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withResources(java.util.Collection resources) {
setResources(resources);
return this;
}
/**
*
* Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @param detailType
* Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event
* detail.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
*/
public void setDetailType(String detailType) {
this.detailType = detailType;
}
/**
*
* Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @return Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event
* detail.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
*/
public String getDetailType() {
return this.detailType;
}
/**
*
* Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @param detailType
* Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event
* detail.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withDetailType(String detailType) {
setDetailType(detailType);
return this;
}
/**
*
* A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @param detail
* A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested
* sub-objects.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
*/
public void setDetail(String detail) {
this.detail = detail;
}
/**
*
* A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @return A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested
* sub-objects.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
*/
public String getDetail() {
return this.detail;
}
/**
*
* A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.
*
*
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include each of
* those properties, EventBridge fails that entry. If you submit a request in which none of the entries have
* each of these properties, EventBridge fails the entire request.
*
*
*
* @param detail
* A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested
* sub-objects.
*
* Detail, DetailType, and Source are required for EventBridge to
* successfully send an event to an event bus. If you include event entries in a request that do not include
* each of those properties, EventBridge fails that entry. If you submit a request in which none of
* the entries have each of these properties, EventBridge fails the entire request.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withDetail(String detail) {
setDetail(detail);
return this;
}
/**
*
* The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are
* used to match the event. If you omit this, the default event bus is used.
*
*
*
* If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN)
* of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding
* event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the
* event bus ARN is preferred.
*
*
*
* @param eventBusName
* The name or ARN of the event bus to receive the event. Only the rules that are associated with this event
* bus are used to match the event. If you omit this, the default event bus is used.
*
* If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name
* (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the
* corresponding event bus in the other Region based on the endpoint referenced by the
* EndpointId. Specifying the event bus ARN is preferred.
*
*/
public void setEventBusName(String eventBusName) {
this.eventBusName = eventBusName;
}
/**
*
* The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are
* used to match the event. If you omit this, the default event bus is used.
*
*
*
* If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN)
* of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding
* event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the
* event bus ARN is preferred.
*
*
*
* @return The name or ARN of the event bus to receive the event. Only the rules that are associated with this event
* bus are used to match the event. If you omit this, the default event bus is used.
*
* If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource
* Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines
* the corresponding event bus in the other Region based on the endpoint referenced by the
* EndpointId. Specifying the event bus ARN is preferred.
*
*/
public String getEventBusName() {
return this.eventBusName;
}
/**
*
* The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are
* used to match the event. If you omit this, the default event bus is used.
*
*
*
* If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN)
* of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding
* event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the
* event bus ARN is preferred.
*
*
*
* @param eventBusName
* The name or ARN of the event bus to receive the event. Only the rules that are associated with this event
* bus are used to match the event. If you omit this, the default event bus is used.
*
* If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name
* (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the
* corresponding event bus in the other Region based on the endpoint referenced by the
* EndpointId. Specifying the event bus ARN is preferred.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withEventBusName(String eventBusName) {
setEventBusName(eventBusName);
return this;
}
/**
*
* An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the
* event.
*
*
* To learn more about X-Ray trace headers, see Tracing
* header in the X-Ray Developer Guide.
*
*
* @param traceHeader
* An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated
* with the event.
*
* To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
*/
public void setTraceHeader(String traceHeader) {
this.traceHeader = traceHeader;
}
/**
*
* An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the
* event.
*
*
* To learn more about X-Ray trace headers, see Tracing
* header in the X-Ray Developer Guide.
*
*
* @return An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated
* with the event.
*
* To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
*/
public String getTraceHeader() {
return this.traceHeader;
}
/**
*
* An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the
* event.
*
*
* To learn more about X-Ray trace headers, see Tracing
* header in the X-Ray Developer Guide.
*
*
* @param traceHeader
* An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated
* with the event.
*
* To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEventsRequestEntry withTraceHeader(String traceHeader) {
setTraceHeader(traceHeader);
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 (getTime() != null)
sb.append("Time: ").append(getTime()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getResources() != null)
sb.append("Resources: ").append(getResources()).append(",");
if (getDetailType() != null)
sb.append("DetailType: ").append(getDetailType()).append(",");
if (getDetail() != null)
sb.append("Detail: ").append(getDetail()).append(",");
if (getEventBusName() != null)
sb.append("EventBusName: ").append(getEventBusName()).append(",");
if (getTraceHeader() != null)
sb.append("TraceHeader: ").append(getTraceHeader());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutEventsRequestEntry == false)
return false;
PutEventsRequestEntry other = (PutEventsRequestEntry) obj;
if (other.getTime() == null ^ this.getTime() == null)
return false;
if (other.getTime() != null && other.getTime().equals(this.getTime()) == 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.getResources() == null ^ this.getResources() == null)
return false;
if (other.getResources() != null && other.getResources().equals(this.getResources()) == false)
return false;
if (other.getDetailType() == null ^ this.getDetailType() == null)
return false;
if (other.getDetailType() != null && other.getDetailType().equals(this.getDetailType()) == false)
return false;
if (other.getDetail() == null ^ this.getDetail() == null)
return false;
if (other.getDetail() != null && other.getDetail().equals(this.getDetail()) == false)
return false;
if (other.getEventBusName() == null ^ this.getEventBusName() == null)
return false;
if (other.getEventBusName() != null && other.getEventBusName().equals(this.getEventBusName()) == false)
return false;
if (other.getTraceHeader() == null ^ this.getTraceHeader() == null)
return false;
if (other.getTraceHeader() != null && other.getTraceHeader().equals(this.getTraceHeader()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTime() == null) ? 0 : getTime().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getResources() == null) ? 0 : getResources().hashCode());
hashCode = prime * hashCode + ((getDetailType() == null) ? 0 : getDetailType().hashCode());
hashCode = prime * hashCode + ((getDetail() == null) ? 0 : getDetail().hashCode());
hashCode = prime * hashCode + ((getEventBusName() == null) ? 0 : getEventBusName().hashCode());
hashCode = prime * hashCode + ((getTraceHeader() == null) ? 0 : getTraceHeader().hashCode());
return hashCode;
}
@Override
public PutEventsRequestEntry clone() {
try {
return (PutEventsRequestEntry) 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.PutEventsRequestEntryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}