ProjectArtifacts (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<ProjectArtifacts.Builder,ProjectArtifacts>

@Generated(value="software.amazon.awssdk:codegen")
public final class ProjectArtifacts
extends Object
implements StructuredPojo, ToCopyableBuilder<ProjectArtifacts.Builder,ProjectArtifacts>

Information about the build output artifacts for the build project.

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
`static ProjectArtifacts.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`location()` Information about the build output artifact location, as follows:
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`name()` Along with `path` and `namespaceType`, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
`ArtifactNamespace`	`namespaceType()` Along with `path` and `name`, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
`String`	`namespaceTypeAsString()` Along with `path` and `name`, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
`ArtifactPackaging`	`packaging()` The type of build output artifact to create, as follows:
`String`	`packagingAsString()` The type of build output artifact to create, as follows:
`String`	`path()` Along with `namespaceType` and `name`, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
`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 will have build output generated through AWS CodePipeline.
    - NO_ARTIFACTS: The build project will not produce any build output.
    - S3: The build project will store 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 will have build output generated through AWS CodePipeline.
    
    NO_ARTIFACTS: The build project will not produce any build output.
    
    S3: The build project will store 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 will have build output generated through AWS CodePipeline.
    - NO_ARTIFACTS: The build project will not produce any build output.
    - S3: The build project will store 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 will have build output generated through AWS CodePipeline.
    
    NO_ARTIFACTS: The build project will not produce any build output.
    
    S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).
    See Also:
    
    ArtifactsType
  - location
```
public String location()
```
    Information about the build output artifact location, as follows:
    - If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    - If type is set to S3, this is the name of the output bucket.
    Returns:
    Information about the build output artifact location, as follows:
    
    If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be 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 will use to name and store the output artifact, as follows:
    - If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    - If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.
    For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.
    Returns:
    Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
    
    If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    
    If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.
    
    For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.
  - namespaceType
```
public ArtifactNamespace namespaceType()
```
    Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
    - If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    - If type is set to S3, then 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, then the output artifact would be 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 will use to determine the name and location to store the output artifact, as follows:
    
    If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    
    If type is set to S3, then 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, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.
    See Also:
    
    ArtifactNamespace
  - namespaceTypeAsString
```
public String namespaceTypeAsString()
```
    Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:
    - If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    - If type is set to S3, then 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, then the output artifact would be 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 will use to determine the name and location to store the output artifact, as follows:
    
    If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    
    If type is set to S3, then 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, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.
    See Also:
    
    ArtifactNamespace
  - name
```
public String name()
```
    Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
    - If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    - If type is set to S3, this is the name of the output artifact object.
    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 would be stored in MyArtifacts/build-ID/MyArtifact.zip.
    Returns:
    Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:
    
    If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    
    If type is set to S3, this is the name of the output artifact object.
    
    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 would be stored in MyArtifacts/build-ID/MyArtifact.zip.
  - packaging
```
public ArtifactPackaging packaging()
```
    The type of build output artifact to create, as follows:
    - If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    - If type is set to S3, valid values include:
      
      NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
      
      ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing 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, as follows:
    
    If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    
    If type is set to S3, valid values include:
    
    NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
    
    ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
    See Also:
    
    ArtifactPackaging
  - packagingAsString
```
public String packagingAsString()
```
    The type of build output artifact to create, as follows:
    - If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    - If type is set to S3, valid values include:
      
      NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
      
      ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing 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, as follows:
    
    If type is set to CODEPIPELINE, then AWS CodePipeline will ignore 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, then this value will be ignored if specified, because no build output will be produced.
    
    If type is set to S3, valid values include:
    
    NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.
    
    ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
    See Also:
    
    ArtifactPackaging
  - 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)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall