Struct aws_sdk_codebuild::types::BuildBatch

#[non_exhaustive]
pub struct BuildBatch {

    pub id: Option<String>,
    pub arn: Option<String>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub current_phase: Option<String>,
    pub build_batch_status: Option<StatusType>,
    pub source_version: Option<String>,
    pub resolved_source_version: Option<String>,
    pub project_name: Option<String>,
    pub phases: Option<Vec<BuildBatchPhase>>,
    pub source: Option<ProjectSource>,
    pub secondary_sources: Option<Vec<ProjectSource>>,
    pub secondary_source_versions: Option<Vec<ProjectSourceVersion>>,
    pub artifacts: Option<BuildArtifacts>,
    pub secondary_artifacts: Option<Vec<BuildArtifacts>>,
    pub cache: Option<ProjectCache>,
    pub environment: Option<ProjectEnvironment>,
    pub service_role: Option<String>,
    pub log_config: Option<LogsConfig>,
    pub build_timeout_in_minutes: Option<i32>,
    pub queued_timeout_in_minutes: Option<i32>,
    pub complete: bool,
    pub initiator: Option<String>,
    pub vpc_config: Option<VpcConfig>,
    pub encryption_key: Option<String>,
    pub build_batch_number: Option<i64>,
    pub file_system_locations: Option<Vec<ProjectFileSystemLocation>>,
    pub build_batch_config: Option<ProjectBuildBatchConfig>,
    pub build_groups: Option<Vec<BuildGroup>>,
    pub debug_session_enabled: Option<bool>,
}

Contains information about a batch build.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The identifier of the batch build.

arn: Option<String>

The ARN of the batch build.

start_time: Option<DateTime>

The date and time that the batch build started.

end_time: Option<DateTime>

The date and time that the batch build ended.

current_phase: Option<String>

The current phase of the batch build.

build_batch_status: Option<StatusType>

The status of the batch build.

source_version: Option<String>

The identifier of the version of the source code to be built.

resolved_source_version: Option<String>

The identifier of the resolved version of this batch build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

• For CodePipeline, the source revision provided by CodePipeline.

• For Amazon S3, this does not apply.

project_name: Option<String>

The name of the batch build project.

phases: Option<Vec<BuildBatchPhase>>

An array of BuildBatchPhase objects the specify the phases of the batch build.

source: Option<ProjectSource>

Information about the build input source code for the build project.

secondary_sources: Option<Vec<ProjectSource>>

An array of ProjectSource objects that define the sources for the batch build.

secondary_source_versions: Option<Vec<ProjectSourceVersion>>

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

artifacts: Option<BuildArtifacts>

A BuildArtifacts object the defines the build artifacts for this batch build.

secondary_artifacts: Option<Vec<BuildArtifacts>>

An array of BuildArtifacts objects the define the build artifacts for this batch build.

cache: Option<ProjectCache>

Information about the cache for the build project.

environment: Option<ProjectEnvironment>

Information about the build environment of the build project.

service_role: Option<String>

The name of a service role used for builds in the batch.

log_config: Option<LogsConfig>

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.

build_timeout_in_minutes: Option<i32>

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

queued_timeout_in_minutes: Option<i32>

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

complete: bool

Indicates if the batch build is complete.

initiator: Option<String>

The entity that started the batch build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

• If a user started the build, the user's name.

• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

vpc_config: Option<VpcConfig>

Information about the VPC configuration that CodeBuild accesses.

encryption_key: Option<String>

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

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/).

build_batch_number: Option<i64>

The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.

file_system_locations: Option<Vec<ProjectFileSystemLocation>>

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

build_batch_config: Option<ProjectBuildBatchConfig>

Contains configuration information about a batch build project.

build_groups: Option<Vec<BuildGroup>>

An array of BuildGroup objects that define the build groups for the batch build.

debug_session_enabled: Option<bool>

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

Implementations

impl BuildBatch

pub fn id(&self) -> Option<&str>

The identifier of the batch build.

pub fn arn(&self) -> Option<&str>

The ARN of the batch build.

pub fn start_time(&self) -> Option<&DateTime>

The date and time that the batch build started.

pub fn end_time(&self) -> Option<&DateTime>

The date and time that the batch build ended.

pub fn current_phase(&self) -> Option<&str>

The current phase of the batch build.

pub fn build_batch_status(&self) -> Option<&StatusType>

The status of the batch build.

pub fn source_version(&self) -> Option<&str>

The identifier of the version of the source code to be built.

pub fn resolved_source_version(&self) -> Option<&str>

The identifier of the resolved version of this batch build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

• For CodePipeline, the source revision provided by CodePipeline.

• For Amazon S3, this does not apply.

pub fn project_name(&self) -> Option<&str>

The name of the batch build project.

pub fn phases(&self) -> &[BuildBatchPhase]

An array of BuildBatchPhase objects the specify the phases of the batch build.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .phases.is_none().

pub fn source(&self) -> Option<&ProjectSource>

Information about the build input source code for the build project.

pub fn secondary_sources(&self) -> &[ProjectSource]

An array of ProjectSource objects that define the sources for the batch build.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_sources.is_none().

pub fn secondary_source_versions(&self) -> &[ProjectSourceVersion]

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_source_versions.is_none().

pub fn artifacts(&self) -> Option<&BuildArtifacts>

A BuildArtifacts object the defines the build artifacts for this batch build.

pub fn secondary_artifacts(&self) -> &[BuildArtifacts]

An array of BuildArtifacts objects the define the build artifacts for this batch build.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_artifacts.is_none().

pub fn cache(&self) -> Option<&ProjectCache>

Information about the cache for the build project.

pub fn environment(&self) -> Option<&ProjectEnvironment>

Information about the build environment of the build project.

pub fn service_role(&self) -> Option<&str>

The name of a service role used for builds in the batch.

pub fn log_config(&self) -> Option<&LogsConfig>

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.

pub fn build_timeout_in_minutes(&self) -> Option<i32>

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

pub fn queued_timeout_in_minutes(&self) -> Option<i32>

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

pub fn complete(&self) -> bool

Indicates if the batch build is complete.

pub fn initiator(&self) -> Option<&str>

The entity that started the batch build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

• If a user started the build, the user's name.

• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

pub fn vpc_config(&self) -> Option<&VpcConfig>

Information about the VPC configuration that CodeBuild accesses.

pub fn encryption_key(&self) -> Option<&str>

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

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/).

pub fn build_batch_number(&self) -> Option<i64>

The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.

pub fn file_system_locations(&self) -> &[ProjectFileSystemLocation]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .file_system_locations.is_none().

pub fn build_batch_config(&self) -> Option<&ProjectBuildBatchConfig>

Contains configuration information about a batch build project.

pub fn build_groups(&self) -> &[BuildGroup]

An array of BuildGroup objects that define the build groups for the batch build.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .build_groups.is_none().

pub fn debug_session_enabled(&self) -> Option<bool>

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

impl BuildBatch

pub fn builder() -> BuildBatchBuilder

Creates a new builder-style object to manufacture BuildBatch.

Trait Implementations

impl Clone for BuildBatch

fn clone(&self) -> BuildBatch

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuildBatch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BuildBatch

fn eq(&self, other: &BuildBatch) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BuildBatch