Class Delivery

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.Delivery
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Delivery.Builder,Delivery>
@Generated("software.amazon.awssdk:codegen") public final class Delivery extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Delivery.Builder,Delivery>

This structure contains information about one delivery in your account.

A delivery is a connection between a logical delivery source and a logical delivery destination.

For more information, see CreateDelivery.

To update an existing delivery configuration, use UpdateDeliveryConfiguration.

See Also:

  • Method Details

    • id

      public final String id()

      The unique ID that identifies this delivery in your account.

      Returns:
      The unique ID that identifies this delivery in your account.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that uniquely identifies this delivery.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies this delivery.

    • deliverySourceName

      public final String deliverySourceName()

      The name of the delivery source that is associated with this delivery.

      Returns:
      The name of the delivery source that is associated with this delivery.

    • deliveryDestinationArn

      public final String deliveryDestinationArn()

      The ARN of the delivery destination that is associated with this delivery.

      Returns:
      The ARN of the delivery destination that is associated with this delivery.

    • deliveryDestinationType

      public final DeliveryDestinationType deliveryDestinationType()

      Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

      If the service returns an enum value that is not available in the current SDK version, deliveryDestinationType will return DeliveryDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryDestinationTypeAsString().

      Returns:
      Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.
      See Also:

    • deliveryDestinationTypeAsString

      public final String deliveryDestinationTypeAsString()

      Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.

      If the service returns an enum value that is not available in the current SDK version, deliveryDestinationType will return DeliveryDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryDestinationTypeAsString().

      Returns:
      Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.
      See Also:

    • hasRecordFields

      public final boolean hasRecordFields()
      For responses, this returns true if the service returned a value for the RecordFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • recordFields

      public final List<String> recordFields()

      The record fields used in this delivery.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecordFields() method.

      Returns:
      The record fields used in this delivery.

    • fieldDelimiter

      public final String fieldDelimiter()

      The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

      Returns:
      The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

    • s3DeliveryConfiguration

      public final S3DeliveryConfiguration s3DeliveryConfiguration()

      This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

      Returns:
      This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tags that have been assigned to this delivery.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags that have been assigned to this delivery.

    • toBuilder

      public Delivery.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Delivery.Builder,Delivery>
      Returns:
      a builder for type T

    • builder

      public static Delivery.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Delivery.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.