ScheduledPreloadJob
- Implements: IScheduledPreloadJob
This class encapsulates and extends the ROS resource type ALIYUN::ESA::ScheduledPreloadJobThe , which type is used to create a scheduled preload job.
Initializers
import com.aliyun.ros.cdk.esa.ScheduledPreloadJob;
ScheduledPreloadJob.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.insertWay(java.lang.String)
.insertWay(IResolvable)
.scheduledPreloadJobName(java.lang.String)
.scheduledPreloadJobName(IResolvable)
.siteId(java.lang.Number)
.siteId(IResolvable)
// .ossUrl(java.lang.String)
// .ossUrl(IResolvable)
// .urlList(IResolvable)
// .urlList(java.util.List<java.lang.String)
// .urlList(IResolvable>)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
insertWay | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property insertWay: The method to submit the URLs to be prefetched. |
scheduledPreloadJobName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property scheduledPreloadJobName: The name of the scheduled prefetch task. |
siteId | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property siteId: The site ID. |
ossUrl | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ossUrl: Preheat OSS files regularly and fill in the OSS file address. |
urlList | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property urlList: A list of URLs to be preheated, which is used when uploading a preheated file in the text box mode. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
insertWayRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property insertWay: The method to submit the URLs to be prefetched.
scheduledPreloadJobNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property scheduledPreloadJobName: The name of the scheduled prefetch task.
siteIdRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property siteId: The site ID.
ossUrlOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ossUrl: Preheat OSS files regularly and fill in the OSS file address.
Note: The OSS file contains the URL that you need to warm up.
urlListOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property urlList: A list of URLs to be preheated, which is used when uploading a preheated file in the text box mode.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.esa.ScheduledPreloadJob;
ScheduledPreloadJob.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the task was created. |
attrDomains | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Domains: The domain names to be prefetched. |
attrErrorInfo | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ErrorInfo: The error message. |
attrFailedFileOss | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute FailedFileOss: OSS address of failed file. |
attrFileId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute FileId: The ID of the URL list file, which can be used during downloads. |
attrInsertWay | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InsertWay: The method to submit the URLs to be prefetched. |
attrScheduledPreloadJobId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ScheduledPreloadJobId: The ID of the prefetch task. |
attrScheduledPreloadJobName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ScheduledPreloadJobName: The task name. |
attrSiteId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SiteId: The site ID. |
attrTaskSubmitted | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TaskSubmitted: The number of submitted prefetch tasks. |
attrTaskType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TaskType: The task type. |
attrUrlCount | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UrlCount: The total number of URLs. |
attrUrlSubmitted | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UrlSubmitted: The number of submitted URLs. |
props | ScheduledPreloadJobProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the task was created.
attrDomainsRequired
public java.lang.Object getAttrDomains();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Domains: The domain names to be prefetched.
attrErrorInfoRequired
public java.lang.Object getAttrErrorInfo();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ErrorInfo: The error message.
attrFailedFileOssRequired
public java.lang.Object getAttrFailedFileOss();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute FailedFileOss: OSS address of failed file.
attrFileIdRequired
public java.lang.Object getAttrFileId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute FileId: The ID of the URL list file, which can be used during downloads.
attrInsertWayRequired
public java.lang.Object getAttrInsertWay();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InsertWay: The method to submit the URLs to be prefetched.
attrScheduledPreloadJobIdRequired
public java.lang.Object getAttrScheduledPreloadJobId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ScheduledPreloadJobId: The ID of the prefetch task.
attrScheduledPreloadJobNameRequired
public java.lang.Object getAttrScheduledPreloadJobName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ScheduledPreloadJobName: The task name.
attrSiteIdRequired
public java.lang.Object getAttrSiteId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SiteId: The site ID.
attrTaskSubmittedRequired
public java.lang.Object getAttrTaskSubmitted();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TaskSubmitted: The number of submitted prefetch tasks.
attrTaskTypeRequired
public java.lang.Object getAttrTaskType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TaskType: The task type.
Valid values: refresh and preload.
attrUrlCountRequired
public java.lang.Object getAttrUrlCount();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UrlCount: The total number of URLs.
attrUrlSubmittedRequired
public java.lang.Object getAttrUrlSubmitted();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UrlSubmitted: The number of submitted URLs.
propsRequired
public ScheduledPreloadJobProps getProps();
- Type: ScheduledPreloadJobProps