Package software.amazon.awssdk.services.ec2.model

Class DescribeFlowLogsRequest

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

  • Method Details

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • hasFilter

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

    • filter

      public final List<Filter> filter()

      One or more filters.

      • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

      • log-destination-type - The type of destination for the flow log data (cloud-watch-logs | s3 | kinesis-data-firehose).

      • flow-log-id - The ID of the flow log.

      • log-group-name - The name of the log group.

      • resource-id - The ID of the VPC, subnet, or network interface.

      • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

      Returns:
      One or more filters.

      • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

      • log-destination-type - The type of destination for the flow log data ( cloud-watch-logs | s3 | kinesis-data-firehose).

      • flow-log-id - The ID of the flow log.

      • log-group-name - The name of the log group.

      • resource-id - The ID of the VPC, subnet, or network interface.

      • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • hasFlowLogIds

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

    • flowLogIds

      public final List<String> flowLogIds()

      One or more flow log IDs.

      Constraint: Maximum of 1000 flow log IDs.

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

      Returns:
      One or more flow log IDs.

      Constraint: Maximum of 1000 flow log IDs.

    • maxResults

      public final Integer maxResults()

      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

      Returns:
      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

    • nextToken

      public final String nextToken()

      The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.

      Returns:
      The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.

    • toBuilder

      public DescribeFlowLogsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeFlowLogsRequest.Builder,DescribeFlowLogsRequest>
      Specified by:
      toBuilder in class Ec2Request

    • builder

      public static DescribeFlowLogsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeFlowLogsRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo