Class ProjectArtifacts

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

Information about the build output artifacts for the build project.

See Also:

  • Method Details

    • type

      public final ArtifactsType type()

      The type of build output artifact. Valid values include:

      • CODEPIPELINE: The build project has build output generated through CodePipeline.

        The CODEPIPELINE type is not supported for secondaryArtifacts.

      • NO_ARTIFACTS: The build project does not produce any build output.

      • S3: The build project stores build output in Amazon S3.

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

      Returns:
      The type of build output artifact. Valid values include:

      • CODEPIPELINE: The build project has build output generated through CodePipeline.

        The CODEPIPELINE type is not supported for secondaryArtifacts.

      • NO_ARTIFACTS: The build project does not produce any build output.

      • S3: The build project stores build output in Amazon S3.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of build output artifact. Valid values include:

      • CODEPIPELINE: The build project has build output generated through CodePipeline.

        The CODEPIPELINE type is not supported for secondaryArtifacts.

      • NO_ARTIFACTS: The build project does not produce any build output.

      • S3: The build project stores build output in Amazon S3.

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

      Returns:
      The type of build output artifact. Valid values include:

      • CODEPIPELINE: The build project has build output generated through CodePipeline.

        The CODEPIPELINE type is not supported for secondaryArtifacts.

      • NO_ARTIFACTS: The build project does not produce any build output.

      • S3: The build project stores build output in Amazon S3.

      See Also:

    • location

      public final String location()

      Information about the build output artifact location:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, this is the name of the output bucket.

      Returns:
      Information about the build output artifact location:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, this is the name of the output bucket.

    • path

      public final String path()

      Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.

      For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.

      Returns:
      Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.

      For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.

    • namespaceType

      public final ArtifactNamespace namespaceType()

      Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • BUILD_ID: Include the build ID in the location of the build output artifact.

        • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

      For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

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

      Returns:
      Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • BUILD_ID: Include the build ID in the location of the build output artifact.

        • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

      For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

      See Also:

    • namespaceTypeAsString

      public final String namespaceTypeAsString()

      Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • BUILD_ID: Include the build ID in the location of the build output artifact.

        • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

      For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

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

      Returns:
      Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • BUILD_ID: Include the build ID in the location of the build output artifact.

        • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

      For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

      See Also:

    • name

      public final String name()

      Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

      For example:

      • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

      • If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket.

      • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/<build-ID>.

      Returns:
      Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.

      For example:

      • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

      • If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket.

      • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/<build-ID>.

    • packaging

      public final ArtifactPackaging packaging()

      The type of build output artifact to create:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

        • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.

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

      Returns:
      The type of build output artifact to create:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

        • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.

      See Also:

    • packagingAsString

      public final String packagingAsString()

      The type of build output artifact to create:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

        • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.

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

      Returns:
      The type of build output artifact to create:

      • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.

      • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

      • If type is set to S3, valid values include:

        • NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

        • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.

      See Also:

    • overrideArtifactName

      public final Boolean overrideArtifactName()

      If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

      Returns:
      If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

    • encryptionDisabled

      public final Boolean encryptionDisabled()

      Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.

      Returns:
      Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.

    • artifactIdentifier

      public final String artifactIdentifier()

      An identifier for this artifact definition.

      Returns:
      An identifier for this artifact definition.

    • bucketOwnerAccess

      public final BucketOwnerAccess bucketOwnerAccess()
      Returns the value of the BucketOwnerAccess property for this object.

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

      Returns:
      The value of the BucketOwnerAccess property for this object.
      See Also:

    • bucketOwnerAccessAsString

      public final String bucketOwnerAccessAsString()
      Returns the value of the BucketOwnerAccess property for this object.

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

      Returns:
      The value of the BucketOwnerAccess property for this object.
      See Also:

    • toBuilder

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

    • builder

      public static ProjectArtifacts.Builder builder()

    • serializableBuilderClass

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