Class ServiceConfiguration

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

Describes a service configuration for a VPC endpoint service.

See Also:

  • Method Details

    • hasServiceType

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

    • serviceType

      public final List<ServiceTypeDetail> serviceType()

      The type of 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 hasServiceType() method.

      Returns:
      The type of service.

    • serviceId

      public final String serviceId()

      The ID of the service.

      Returns:
      The ID of the service.

    • serviceName

      public final String serviceName()

      The name of the service.

      Returns:
      The name of the service.

    • serviceState

      public final ServiceState serviceState()

      The service state.

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

      Returns:
      The service state.
      See Also:

    • serviceStateAsString

      public final String serviceStateAsString()

      The service state.

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

      Returns:
      The service state.
      See Also:

    • hasAvailabilityZones

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

    • availabilityZones

      public final List<String> availabilityZones()

      The Availability Zones in which the service is available.

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

      Returns:
      The Availability Zones in which the service is available.

    • acceptanceRequired

      public final Boolean acceptanceRequired()

      Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

      Returns:
      Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.

    • managesVpcEndpoints

      public final Boolean managesVpcEndpoints()

      Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

      Returns:
      Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

    • hasNetworkLoadBalancerArns

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

    • networkLoadBalancerArns

      public final List<String> networkLoadBalancerArns()

      The Amazon Resource Names (ARNs) of the Network Load Balancers for 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 hasNetworkLoadBalancerArns() method.

      Returns:
      The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

    • hasGatewayLoadBalancerArns

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

    • gatewayLoadBalancerArns

      public final List<String> gatewayLoadBalancerArns()

      The Amazon Resource Names (ARNs) of the Gateway Load Balancers for 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 hasGatewayLoadBalancerArns() method.

      Returns:
      The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

    • supportedIpAddressTypes

      public final List<ServiceConnectivityType> supportedIpAddressTypes()

      The supported IP address types.

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

      Returns:
      The supported IP address types.

    • hasSupportedIpAddressTypes

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

    • supportedIpAddressTypesAsStrings

      public final List<String> supportedIpAddressTypesAsStrings()

      The supported IP address types.

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

      Returns:
      The supported IP address types.

    • hasBaseEndpointDnsNames

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

    • baseEndpointDnsNames

      public final List<String> baseEndpointDnsNames()

      The DNS names for 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 hasBaseEndpointDnsNames() method.

      Returns:
      The DNS names for the service.

    • privateDnsName

      public final String privateDnsName()

      The private DNS name for the service.

      Returns:
      The private DNS name for the service.

    • privateDnsNameConfiguration

      public final PrivateDnsNameConfiguration privateDnsNameConfiguration()

      Information about the endpoint service private DNS name configuration.

      Returns:
      Information about the endpoint service private DNS name configuration.

    • payerResponsibility

      public final PayerResponsibility payerResponsibility()

      The payer responsibility.

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

      Returns:
      The payer responsibility.
      See Also:

    • payerResponsibilityAsString

      public final String payerResponsibilityAsString()

      The payer responsibility.

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

      Returns:
      The payer responsibility.
      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 List<Tag> tags()

      The tags assigned to 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 hasTags() method.

      Returns:
      The tags assigned to the service.

    • hasSupportedRegions

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

    • supportedRegions

      public final List<SupportedRegionDetail> supportedRegions()

      The supported Regions.

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

      Returns:
      The supported Regions.

    • remoteAccessEnabled

      public final Boolean remoteAccessEnabled()

      Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.

      Returns:
      Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.

    • toBuilder

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

    • builder

      public static ServiceConfiguration.Builder builder()

    • serializableBuilderClass

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