Class RegisterContainerImageRequest

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

  • Method Details

    • serviceName

      public final String serviceName()

      The name of the container service for which to register a container image.

      Returns:
      The name of the container service for which to register a container image.

    • label

      public final String label()

      The label for the container image when it's registered to the container service.

      Use a descriptive label that you can use to track the different versions of your registered container images.

      Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

      • :container-service-1.<imagelabel>.1

      If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

      The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

      Returns:
      The label for the container image when it's registered to the container service.

      Use a descriptive label that you can use to track the different versions of your registered container images.

      Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example:

      • :container-service-1.<imagelabel>.1

      If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1.

      The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on.

    • digest

      public final String digest()

      The digest of the container image to be registered.

      Returns:
      The digest of the container image to be registered.

    • toBuilder

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

    • builder

      public static RegisterContainerImageRequest.Builder builder()

    • serializableBuilderClass

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