ProjectArtifacts (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.codebuild.model.ProjectArtifacts

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ProjectArtifacts.Builder,ProjectArtifacts>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ProjectArtifacts.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProjectArtifacts.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`artifactIdentifier()` An identifier for this artifact definition.
`static ProjectArtifacts.Builder`	`builder()`
`Boolean`	`encryptionDisabled()` Set to true if you do not want your output artifacts encrypted.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`location()` Information about the build output artifact location:
`String`	`name()` Along with `path` and `namespaceType`, the pattern that AWS CodeBuild uses to name and store the output artifact:
`ArtifactNamespace`	`namespaceType()` Along with `path` and `name`, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
`String`	`namespaceTypeAsString()` Along with `path` and `name`, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
`Boolean`	`overrideArtifactName()` If this flag is set, a name specified in the build spec file overrides the artifact name.
`ArtifactPackaging`	`packaging()` The type of build output artifact to create:
`String`	`packagingAsString()` The type of build output artifact to create:
`String`	`path()` Along with `namespaceType` and `name`, the pattern that AWS CodeBuild uses to name and store the output artifact:
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ProjectArtifacts.Builder>`	`serializableBuilderClass()`
`ProjectArtifacts.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`ArtifactsType`	`type()` The type of build output artifact.
`String`	`typeAsString()` The type of build output artifact.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - type
```
public ArtifactsType type()
```
    The type of build output artifact. Valid values include:
    - CODEPIPELINE: The build project has build output generated through AWS CodePipeline.
    - NO_ARTIFACTS: The build project does not produce any build output.
    - S3: The build project stores build output in Amazon Simple Storage Service (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 AWS CodePipeline.
    
    NO_ARTIFACTS: The build project does not produce any build output.
    
    S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).
    See Also:
    
    ArtifactsType
  - typeAsString
```
public String typeAsString()
```
    The type of build output artifact. Valid values include:
    - CODEPIPELINE: The build project has build output generated through AWS CodePipeline.
    - NO_ARTIFACTS: The build project does not produce any build output.
    - S3: The build project stores build output in Amazon Simple Storage Service (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 AWS CodePipeline.
    
    NO_ARTIFACTS: The build project does not produce any build output.
    
    S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).
    See Also:
    
    ArtifactsType
  - location
```
public String location()
```
    Information about the build output artifact location:
    - If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS 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, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS 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 String path()
```
    Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:
    - If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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 AWS CodeBuild uses to name and store the output artifact:
    
    If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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 ArtifactNamespace namespaceType()
```
    Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
    - If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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 AWS CodeBuild uses to determine the name and location to store the output artifact:
    
    If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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:
    
    ArtifactNamespace
  - namespaceTypeAsString
```
public String namespaceTypeAsString()
```
    Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:
    - If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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 AWS CodeBuild uses to determine the name and location to store the output artifact:
    
    If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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:
    
    ArtifactNamespace
  - name
```
public String name()
```
    Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:
    - If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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 AWS CodeBuild uses to name and store the output artifact:
    
    If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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 ArtifactPackaging packaging()
```
    The type of build output artifact to create:
    - If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS 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: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
      
      ZIP: AWS 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, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS 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: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
    
    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
    See Also:
    
    ArtifactPackaging
  - packagingAsString
```
public String packagingAsString()
```
    The type of build output artifact to create:
    - If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS 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: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
      
      ZIP: AWS 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, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS 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: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
    
    ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
    See Also:
    
    ArtifactPackaging
  - overrideArtifactName
```
public Boolean overrideArtifactName()
```
    If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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 build spec file overrides the artifact name. The name specified in a build spec 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 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 Simple Storage Service (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 Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.
  - artifactIdentifier
```
public String artifactIdentifier()
```
    An identifier for this artifact definition.
    
    Returns:
    
    An identifier for this artifact definition.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class ProjectArtifacts

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

type

typeAsString

location

path

namespaceType

namespaceTypeAsString

name

packaging

packagingAsString

overrideArtifactName

encryptionDisabled

artifactIdentifier

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields