Class Schedule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Schedule.Builder,
Schedule>
A schedule configures when and how often a pipeline will automatically create a new image.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Schedule.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
The condition configures when the pipeline should trigger a new image build.final String
The condition configures when the pipeline should trigger a new image build.final String
The cron expression determines how often EC2 Image Builder evaluates yourpipelineExecutionStartCondition
.static Class
<? extends Schedule.Builder> final String
timezone()
The timezone that applies to the scheduling expression.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
scheduleExpression
The cron expression determines how often EC2 Image Builder evaluates your
pipelineExecutionStartCondition
.For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
- Returns:
- The cron expression determines how often EC2 Image Builder evaluates your
pipelineExecutionStartCondition
.For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
-
timezone
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
- Returns:
- The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
-
pipelineExecutionStartCondition
The condition configures when the pipeline should trigger a new image build. When the
pipelineExecutionStartCondition
is set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set toEXPRESSION_MATCH_ONLY
, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.If the service returns an enum value that is not available in the current SDK version,
pipelineExecutionStartCondition
will returnPipelineExecutionStartCondition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompipelineExecutionStartConditionAsString()
.- Returns:
- The condition configures when the pipeline should trigger a new image build. When the
pipelineExecutionStartCondition
is set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set toEXPRESSION_MATCH_ONLY
, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference. - See Also:
-
pipelineExecutionStartConditionAsString
The condition configures when the pipeline should trigger a new image build. When the
pipelineExecutionStartCondition
is set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set toEXPRESSION_MATCH_ONLY
, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.If the service returns an enum value that is not available in the current SDK version,
pipelineExecutionStartCondition
will returnPipelineExecutionStartCondition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompipelineExecutionStartConditionAsString()
.- Returns:
- The condition configures when the pipeline should trigger a new image build. When the
pipelineExecutionStartCondition
is set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set toEXPRESSION_MATCH_ONLY
, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference. - See Also:
-
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 interfaceToCopyableBuilder<Schedule.Builder,
Schedule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-