Class Sandbox

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

Contains sandbox information.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the sandbox.

      Returns:
      The ID of the sandbox.

    • arn

      public final String arn()

      The ARN of the sandbox.

      Returns:
      The ARN of the sandbox.

    • projectName

      public final String projectName()

      The CodeBuild project name.

      Returns:
      The CodeBuild project name.

    • requestTime

      public final Instant requestTime()

      When the sandbox process was initially requested, expressed in Unix time format.

      Returns:
      When the sandbox process was initially requested, expressed in Unix time format.

    • startTime

      public final Instant startTime()

      When the sandbox process started, expressed in Unix time format.

      Returns:
      When the sandbox process started, expressed in Unix time format.

    • endTime

      public final Instant endTime()

      When the sandbox process ended, expressed in Unix time format.

      Returns:
      When the sandbox process ended, expressed in Unix time format.

    • status

      public final String status()

      The status of the sandbox.

      Returns:
      The status of the sandbox.

    • source

      public final ProjectSource source()
      Returns the value of the Source property for this object.
      Returns:
      The value of the Source property for this object.

    • sourceVersion

      public final String sourceVersion()

      Any version identifier for the version of the sandbox to be built.

      Returns:
      Any version identifier for the version of the sandbox to be built.

    • hasSecondarySources

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

    • secondarySources

      public final List<ProjectSource> secondarySources()

      An array of ProjectSource objects.

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

      Returns:
      An array of ProjectSource objects.

    • hasSecondarySourceVersions

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

    • secondarySourceVersions

      public final List<ProjectSourceVersion> secondarySourceVersions()

      An array of ProjectSourceVersion objects.

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

      Returns:
      An array of ProjectSourceVersion objects.

    • environment

      public final ProjectEnvironment environment()
      Returns the value of the Environment property for this object.
      Returns:
      The value of the Environment property for this object.

    • hasFileSystemLocations

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

    • fileSystemLocations

      public final List<ProjectFileSystemLocation> fileSystemLocations()

      An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

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

      Returns:
      An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

    • timeoutInMinutes

      public final Integer timeoutInMinutes()

      How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this sandbox if it does not get marked as completed.

      Returns:
      How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this sandbox if it does not get marked as completed.

    • queuedTimeoutInMinutes

      public final Integer queuedTimeoutInMinutes()

      The number of minutes a sandbox is allowed to be queued before it times out.

      Returns:
      The number of minutes a sandbox is allowed to be queued before it times out.

    • vpcConfig

      public final VpcConfig vpcConfig()
      Returns the value of the VpcConfig property for this object.
      Returns:
      The value of the VpcConfig property for this object.

    • logConfig

      public final LogsConfig logConfig()
      Returns the value of the LogConfig property for this object.
      Returns:
      The value of the LogConfig property for this object.

    • encryptionKey

      public final String encryptionKey()

      The Key Management Service customer master key (CMK) to be used for encrypting the sandbox output artifacts.

      Returns:
      The Key Management Service customer master key (CMK) to be used for encrypting the sandbox output artifacts.

    • serviceRole

      public final String serviceRole()

      The name of a service role used for this sandbox.

      Returns:
      The name of a service role used for this sandbox.

    • currentSession

      public final SandboxSession currentSession()

      The current session for the sandbox.

      Returns:
      The current session for the sandbox.

    • toBuilder

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

    • builder

      public static Sandbox.Builder builder()

    • serializableBuilderClass

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