Package software.amazon.awssdk.services.proton.model

Class Service

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

Detailed data of an Proton service resource.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the service.

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

    • branchName

      public final String branchName()

      The name of the code repository branch that holds the code that's deployed in Proton.

      Returns:
      The name of the code repository branch that holds the code that's deployed in Proton.

    • createdAt

      public final Instant createdAt()

      The time when the service was created.

      Returns:
      The time when the service was created.

    • description

      public final String description()

      A description of the service.

      Returns:
      A description of the service.

    • lastModifiedAt

      public final Instant lastModifiedAt()

      The time when the service was last modified.

      Returns:
      The time when the service was last modified.

    • name

      public final String name()

      The name of the service.

      Returns:
      The name of the service.

    • pipeline

      public final ServicePipeline pipeline()

      The service pipeline detail data.

      Returns:
      The service pipeline detail data.

    • repositoryConnectionArn

      public final String repositoryConnectionArn()

      The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.

    • repositoryId

      public final String repositoryId()

      The ID of the source code repository.

      Returns:
      The ID of the source code repository.

    • spec

      public final String spec()

      The formatted specification that defines the service.

      Returns:
      The formatted specification that defines the service.

    • status

      public final ServiceStatus status()

      The status of the service.

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

      Returns:
      The status of the service.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the service.

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

      Returns:
      The status of the service.
      See Also:

    • statusMessage

      public final String statusMessage()

      A service status message.

      Returns:
      A service status message.

    • templateName

      public final String templateName()

      The name of the service template.

      Returns:
      The name of the service template.

    • toBuilder

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

    • builder

      public static Service.Builder builder()

    • serializableBuilderClass

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