Class TargetGroupSummary

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

Summary information about a target group.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the target group.

      Returns:
      The ID of the target group.

    • arn

      public final String arn()

      The ARN (Amazon Resource Name) of the target group.

      Returns:
      The ARN (Amazon Resource Name) of the target group.

    • name

      public final String name()

      The name of the target group.

      Returns:
      The name of the target group.

    • type

      public final TargetGroupType type()

      The target group type.

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

      Returns:
      The target group type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The target group type.

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

      Returns:
      The target group type.
      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time that the target group was created, in ISO-8601 format.

      Returns:
      The date and time that the target group was created, in ISO-8601 format.

    • port

      public final Integer port()

      The port of the target group.

      Returns:
      The port of the target group.

    • protocol

      public final TargetGroupProtocol protocol()

      The protocol of the target group.

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

      Returns:
      The protocol of the target group.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol of the target group.

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

      Returns:
      The protocol of the target group.
      See Also:

    • ipAddressType

      public final IpAddressType ipAddressType()

      The type of IP address used for the target group. The possible values are IPV4 and IPV6 . This is an optional parameter. If not specified, the default is IPV4.

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

      Returns:
      The type of IP address used for the target group. The possible values are IPV4 and IPV6. This is an optional parameter. If not specified, the default is IPV4.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The type of IP address used for the target group. The possible values are IPV4 and IPV6 . This is an optional parameter. If not specified, the default is IPV4.

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

      Returns:
      The type of IP address used for the target group. The possible values are IPV4 and IPV6. This is an optional parameter. If not specified, the default is IPV4.
      See Also:

    • vpcIdentifier

      public final String vpcIdentifier()

      The ID of the VPC of the target group.

      Returns:
      The ID of the VPC of the target group.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time that the target group was last updated, in ISO-8601 format.

      Returns:
      The date and time that the target group was last updated, in ISO-8601 format.

    • status

      public final TargetGroupStatus status()

      The status.

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

      Returns:
      The status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status.

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

      Returns:
      The status.
      See Also:

    • hasServiceArns

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

    • serviceArns

      public final List<String> serviceArns()

      The Amazon Resource Names (ARNs) of the service.

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

      Returns:
      The Amazon Resource Names (ARNs) of the service.

    • lambdaEventStructureVersion

      public final LambdaEventStructureVersion lambdaEventStructureVersion()

      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA.

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

      Returns:
      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA.
      See Also:

    • lambdaEventStructureVersionAsString

      public final String lambdaEventStructureVersionAsString()

      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA.

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

      Returns:
      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA.
      See Also:

    • toBuilder

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

    • builder

      public static TargetGroupSummary.Builder builder()

    • serializableBuilderClass

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