Class DescribeConfigurationTemplatesRequest

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.DescribeConfigurationTemplatesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeConfigurationTemplatesRequest.Builder,DescribeConfigurationTemplatesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeConfigurationTemplatesRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<DescribeConfigurationTemplatesRequest.Builder,DescribeConfigurationTemplatesRequest>

  • Method Details

    • service

      public final String service()

      Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here.

      Returns:
      Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here.

    • hasLogTypes

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

    • logTypes

      public final List<String> logTypes()

      Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here.

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

      Returns:
      Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here.

    • hasResourceTypes

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

    • resourceTypes

      public final List<String> resourceTypes()

      Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here.

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

      Returns:
      Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here.

    • deliveryDestinationTypes

      public final List<DeliveryDestinationType> deliveryDestinationTypes()

      Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.

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

      Returns:
      Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.

    • hasDeliveryDestinationTypes

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

    • deliveryDestinationTypesAsStrings

      public final List<String> deliveryDestinationTypesAsStrings()

      Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.

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

      Returns:
      Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.

    • nextToken

      public final String nextToken()
      Returns the value of the NextToken property for this object.
      Returns:
      The value of the NextToken property for this object.

    • limit

      public final Integer limit()

      Use this parameter to limit the number of configuration templates that are returned in the response.

      Returns:
      Use this parameter to limit the number of configuration templates that are returned in the response.

    • toBuilder

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

    • builder

      public static DescribeConfigurationTemplatesRequest.Builder builder()

    • serializableBuilderClass

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