#[non_exhaustive]pub struct Build {Show 33 fields
pub id: Option<String>,
pub arn: Option<String>,
pub build_number: Option<i64>,
pub start_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub current_phase: Option<String>,
pub build_status: Option<StatusType>,
pub source_version: Option<String>,
pub resolved_source_version: Option<String>,
pub project_name: Option<String>,
pub phases: Option<Vec<BuildPhase>>,
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 logs: Option<LogsLocation>,
pub timeout_in_minutes: Option<i32>,
pub queued_timeout_in_minutes: Option<i32>,
pub build_complete: bool,
pub initiator: Option<String>,
pub vpc_config: Option<VpcConfig>,
pub network_interface: Option<NetworkInterface>,
pub encryption_key: Option<String>,
pub exported_environment_variables: Option<Vec<ExportedEnvironmentVariable>>,
pub report_arns: Option<Vec<String>>,
pub file_system_locations: Option<Vec<ProjectFileSystemLocation>>,
pub debug_session: Option<DebugSession>,
pub build_batch_arn: Option<String>,
pub auto_retry_config: Option<AutoRetryConfig>,
}
Expand description
Information about a build.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: Option<String>
The unique ID for the build.
arn: Option<String>
The Amazon Resource Name (ARN) of the build.
build_number: Option<i64>
The number of the build. For each project, the buildNumber
of its first build is 1
. The buildNumber
of each subsequent build is incremented by 1
. If a build is deleted, the buildNumber
of other builds does not change.
start_time: Option<DateTime>
When the build process started, expressed in Unix time format.
end_time: Option<DateTime>
When the build process ended, expressed in Unix time format.
current_phase: Option<String>
The current build phase.
build_status: Option<StatusType>
The current status of the build. Valid values include:
-
FAILED
: The build failed. -
FAULT
: The build faulted. -
IN_PROGRESS
: The build is still in progress. -
STOPPED
: The build stopped. -
SUCCEEDED
: The build succeeded. -
TIMED_OUT
: The build timed out.
source_version: Option<String>
Any version identifier for the version of the source code to be built. If sourceVersion
is specified at the project level, then this sourceVersion
(at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
resolved_source_version: Option<String>
An identifier for the version of this 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 CodeBuild project.
phases: Option<Vec<BuildPhase>>
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
source: Option<ProjectSource>
Information about the source code to be built.
secondary_sources: Option<Vec<ProjectSource>>
An array of ProjectSource
objects.
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>
Information about the output artifacts for the build.
secondary_artifacts: Option<Vec<BuildArtifacts>>
An array of ProjectArtifacts
objects.
cache: Option<ProjectCache>
Information about the cache for the build.
environment: Option<ProjectEnvironment>
Information about the build environment for this build.
service_role: Option<String>
The name of a service role used for this build.
logs: Option<LogsLocation>
Information about the build's logs in CloudWatch Logs.
timeout_in_minutes: Option<i32>
How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.
queued_timeout_in_minutes: Option<i32>
The number of minutes a build is allowed to be queued before it times out.
build_complete: bool
Whether the build is complete. True if complete; otherwise, false.
initiator: Option<String>
The entity that started the 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 (for example,
MyUserName
). -
If the Jenkins plugin for CodeBuild started the build, the string
CodeBuild-Jenkins-Plugin
.
vpc_config: Option<VpcConfig>
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
network_interface: Option<NetworkInterface>
Describes a network interface.
encryption_key: Option<String>
The Key Management Service customer master key (CMK) to be used for encrypting the 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/
).
exported_environment_variables: Option<Vec<ExportedEnvironmentVariable>>
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
report_arns: Option<Vec<String>>
An array of the ARNs associated with this build's reports.
file_system_locations: Option<Vec<ProjectFileSystemLocation>>
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.
debug_session: Option<DebugSession>
Contains information about the debug session for this build.
build_batch_arn: Option<String>
The ARN of the batch build that this build is a member of, if applicable.
auto_retry_config: Option<AutoRetryConfig>
Information about the auto-retry configuration for the build.
Implementations§
Source§impl Build
impl Build
Sourcepub fn build_number(&self) -> Option<i64>
pub fn build_number(&self) -> Option<i64>
The number of the build. For each project, the buildNumber
of its first build is 1
. The buildNumber
of each subsequent build is incremented by 1
. If a build is deleted, the buildNumber
of other builds does not change.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
When the build process started, expressed in Unix time format.
Sourcepub fn end_time(&self) -> Option<&DateTime>
pub fn end_time(&self) -> Option<&DateTime>
When the build process ended, expressed in Unix time format.
Sourcepub fn current_phase(&self) -> Option<&str>
pub fn current_phase(&self) -> Option<&str>
The current build phase.
Sourcepub fn build_status(&self) -> Option<&StatusType>
pub fn build_status(&self) -> Option<&StatusType>
The current status of the build. Valid values include:
-
FAILED
: The build failed. -
FAULT
: The build faulted. -
IN_PROGRESS
: The build is still in progress. -
STOPPED
: The build stopped. -
SUCCEEDED
: The build succeeded. -
TIMED_OUT
: The build timed out.
Sourcepub fn source_version(&self) -> Option<&str>
pub fn source_version(&self) -> Option<&str>
Any version identifier for the version of the source code to be built. If sourceVersion
is specified at the project level, then this sourceVersion
(at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
Sourcepub fn resolved_source_version(&self) -> Option<&str>
pub fn resolved_source_version(&self) -> Option<&str>
An identifier for the version of this 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.
Sourcepub fn project_name(&self) -> Option<&str>
pub fn project_name(&self) -> Option<&str>
The name of the CodeBuild project.
Sourcepub fn phases(&self) -> &[BuildPhase]
pub fn phases(&self) -> &[BuildPhase]
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
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()
.
Sourcepub fn source(&self) -> Option<&ProjectSource>
pub fn source(&self) -> Option<&ProjectSource>
Information about the source code to be built.
Sourcepub fn secondary_sources(&self) -> &[ProjectSource]
pub fn secondary_sources(&self) -> &[ProjectSource]
An array of ProjectSource
objects.
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()
.
Sourcepub fn secondary_source_versions(&self) -> &[ProjectSourceVersion]
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()
.
Sourcepub fn artifacts(&self) -> Option<&BuildArtifacts>
pub fn artifacts(&self) -> Option<&BuildArtifacts>
Information about the output artifacts for the build.
Sourcepub fn secondary_artifacts(&self) -> &[BuildArtifacts]
pub fn secondary_artifacts(&self) -> &[BuildArtifacts]
An array of ProjectArtifacts
objects.
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()
.
Sourcepub fn cache(&self) -> Option<&ProjectCache>
pub fn cache(&self) -> Option<&ProjectCache>
Information about the cache for the build.
Sourcepub fn environment(&self) -> Option<&ProjectEnvironment>
pub fn environment(&self) -> Option<&ProjectEnvironment>
Information about the build environment for this build.
Sourcepub fn service_role(&self) -> Option<&str>
pub fn service_role(&self) -> Option<&str>
The name of a service role used for this build.
Sourcepub fn logs(&self) -> Option<&LogsLocation>
pub fn logs(&self) -> Option<&LogsLocation>
Information about the build's logs in CloudWatch Logs.
Sourcepub fn timeout_in_minutes(&self) -> Option<i32>
pub fn timeout_in_minutes(&self) -> Option<i32>
How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.
Sourcepub fn queued_timeout_in_minutes(&self) -> Option<i32>
pub fn queued_timeout_in_minutes(&self) -> Option<i32>
The number of minutes a build is allowed to be queued before it times out.
Sourcepub fn build_complete(&self) -> bool
pub fn build_complete(&self) -> bool
Whether the build is complete. True if complete; otherwise, false.
Sourcepub fn initiator(&self) -> Option<&str>
pub fn initiator(&self) -> Option<&str>
The entity that started the 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 (for example,
MyUserName
). -
If the Jenkins plugin for CodeBuild started the build, the string
CodeBuild-Jenkins-Plugin
.
Sourcepub fn vpc_config(&self) -> Option<&VpcConfig>
pub fn vpc_config(&self) -> Option<&VpcConfig>
If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
Sourcepub fn network_interface(&self) -> Option<&NetworkInterface>
pub fn network_interface(&self) -> Option<&NetworkInterface>
Describes a network interface.
Sourcepub fn encryption_key(&self) -> Option<&str>
pub fn encryption_key(&self) -> Option<&str>
The Key Management Service customer master key (CMK) to be used for encrypting the 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/
).
Sourcepub fn exported_environment_variables(&self) -> &[ExportedEnvironmentVariable]
pub fn exported_environment_variables(&self) -> &[ExportedEnvironmentVariable]
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exported_environment_variables.is_none()
.
Sourcepub fn report_arns(&self) -> &[String]
pub fn report_arns(&self) -> &[String]
An array of the ARNs associated with this build's reports.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .report_arns.is_none()
.
Sourcepub fn file_system_locations(&self) -> &[ProjectFileSystemLocation]
pub fn file_system_locations(&self) -> &[ProjectFileSystemLocation]
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.
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()
.
Sourcepub fn debug_session(&self) -> Option<&DebugSession>
pub fn debug_session(&self) -> Option<&DebugSession>
Contains information about the debug session for this build.
Sourcepub fn build_batch_arn(&self) -> Option<&str>
pub fn build_batch_arn(&self) -> Option<&str>
The ARN of the batch build that this build is a member of, if applicable.
Sourcepub fn auto_retry_config(&self) -> Option<&AutoRetryConfig>
pub fn auto_retry_config(&self) -> Option<&AutoRetryConfig>
Information about the auto-retry configuration for the build.
Trait Implementations§
impl StructuralPartialEq for Build
Auto Trait Implementations§
impl Freeze for Build
impl RefUnwindSafe for Build
impl Send for Build
impl Sync for Build
impl Unpin for Build
impl UnwindSafe for Build
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);