Class Origin

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

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the origin resource.

      Returns:
      The name of the origin resource.

    • resourceType

      public final ResourceType resourceType()

      The resource type of the origin resource (Instance).

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

      Returns:
      The resource type of the origin resource (Instance).
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The resource type of the origin resource (Instance).

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

      Returns:
      The resource type of the origin resource (Instance).
      See Also:

    • regionName

      public final RegionName regionName()

      The AWS Region name of the origin resource.

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

      Returns:
      The AWS Region name of the origin resource.
      See Also:

    • regionNameAsString

      public final String regionNameAsString()

      The AWS Region name of the origin resource.

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

      Returns:
      The AWS Region name of the origin resource.
      See Also:

    • protocolPolicy

      public final OriginProtocolPolicyEnum protocolPolicy()

      The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

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

      Returns:
      The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
      See Also:

    • protocolPolicyAsString

      public final String protocolPolicyAsString()

      The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

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

      Returns:
      The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
      See Also:

    • responseTimeout

      public final Integer responseTimeout()

      The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.

      Returns:
      The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.

    • toBuilder

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

    • builder

      public static Origin.Builder builder()

    • serializableBuilderClass

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