Package software.amazon.awssdk.services.cloudfront.model

Class RealtimeLogConfig

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

A real-time log configuration.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of this real-time log configuration.

      Returns:
      The Amazon Resource Name (ARN) of this real-time log configuration.

    • name

      public final String name()

      The unique name of this real-time log configuration.

      Returns:
      The unique name of this real-time log configuration.

    • samplingRate

      public final Long samplingRate()

      The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.

      Returns:
      The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.

    • hasEndPoints

      public final boolean hasEndPoints()
      For responses, this returns true if the service returned a value for the EndPoints 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.

    • endPoints

      public final List<EndPoint> endPoints()

      Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

      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 hasEndPoints() method.

      Returns:
      Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

    • hasFields

      public final boolean hasFields()
      For responses, this returns true if the service returned a value for the Fields 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.

    • fields

      public final List<String> fields()

      A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

      For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

      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 hasFields() method.

      Returns:
      A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

      For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

    • toBuilder

      public RealtimeLogConfig.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<RealtimeLogConfig.Builder,RealtimeLogConfig>
      Returns:
      a builder for type T

    • builder

      public static RealtimeLogConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RealtimeLogConfig.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.