Class PutDeliveryDestinationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
software.amazon.awssdk.services.cloudwatchlogs.model.PutDeliveryDestinationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutDeliveryDestinationRequest.Builder,PutDeliveryDestinationRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutDeliveryDestinationRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<PutDeliveryDestinationRequest.Builder,PutDeliveryDestinationRequest>

  • Method Details

    • name

      public final String name()

      A name for this delivery destination. This name must be unique for all delivery destinations in your account.

      Returns:
      A name for this delivery destination. This name must be unique for all delivery destinations in your account.

    • outputFormat

      public final OutputFormat outputFormat()

      The format for the logs that this delivery destination will receive.

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

      Returns:
      The format for the logs that this delivery destination will receive.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The format for the logs that this delivery destination will receive.

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

      Returns:
      The format for the logs that this delivery destination will receive.
      See Also:

    • deliveryDestinationConfiguration

      public final DeliveryDestinationConfiguration deliveryDestinationConfiguration()

      A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

      deliveryDestinationConfiguration is required for CloudWatch Logs, Amazon S3, Firehose log delivery destinations and not required for X-Ray trace delivery destinations. deliveryDestinationType is needed for X-Ray trace delivery destinations but not required for other logs delivery destinations.

      Returns:
      A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

      deliveryDestinationConfiguration is required for CloudWatch Logs, Amazon S3, Firehose log delivery destinations and not required for X-Ray trace delivery destinations. deliveryDestinationType is needed for X-Ray trace delivery destinations but not required for other logs delivery destinations.

    • deliveryDestinationType

      public final DeliveryDestinationType deliveryDestinationType()

      The type of delivery destination. This parameter specifies the target service where log data will be delivered. Valid values include:

      • S3 - Amazon S3 for long-term storage and analytics

      • CWL - CloudWatch Logs for centralized log management

      • FH - Amazon Kinesis Data Firehose for real-time data streaming

      • XRAY - Amazon Web Services X-Ray for distributed tracing and application monitoring

      The delivery destination type determines the format and configuration options available for log delivery.

      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:
      The type of delivery destination. This parameter specifies the target service where log data will be delivered. Valid values include:

      • S3 - Amazon S3 for long-term storage and analytics

      • CWL - CloudWatch Logs for centralized log management

      • FH - Amazon Kinesis Data Firehose for real-time data streaming

      • XRAY - Amazon Web Services X-Ray for distributed tracing and application monitoring

      The delivery destination type determines the format and configuration options available for log delivery.

      See Also:

    • deliveryDestinationTypeAsString

      public final String deliveryDestinationTypeAsString()

      The type of delivery destination. This parameter specifies the target service where log data will be delivered. Valid values include:

      • S3 - Amazon S3 for long-term storage and analytics

      • CWL - CloudWatch Logs for centralized log management

      • FH - Amazon Kinesis Data Firehose for real-time data streaming

      • XRAY - Amazon Web Services X-Ray for distributed tracing and application monitoring

      The delivery destination type determines the format and configuration options available for log delivery.

      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:
      The type of delivery destination. This parameter specifies the target service where log data will be delivered. Valid values include:

      • S3 - Amazon S3 for long-term storage and analytics

      • CWL - CloudWatch Logs for centralized log management

      • FH - Amazon Kinesis Data Firehose for real-time data streaming

      • XRAY - Amazon Web Services X-Ray for distributed tracing and application monitoring

      The delivery destination type determines the format and configuration options available for log delivery.

      See Also:

    • 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()

      An optional list of key-value pairs to associate with the resource.

      For more information about tagging, see Tagging Amazon Web Services resources

      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:
      An optional list of key-value pairs to associate with the resource.

      For more information about tagging, see Tagging Amazon Web Services resources

    • toBuilder

      public PutDeliveryDestinationRequest.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<PutDeliveryDestinationRequest.Builder,PutDeliveryDestinationRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest
      Returns:
      a builder for type T

    • builder

      public static PutDeliveryDestinationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.