CodeSource

This class encapsulates and extends the ROS resource type ALIYUN::PAI::CodeSource.

Initializers

import com.aliyun.ros.cdk.pai.CodeSource;
CodeSource.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .accessibility(java.lang.String)
    .accessibility(IResolvable)
    .codeRepo(java.lang.String)
    .codeRepo(IResolvable)
    .displayName(java.lang.String)
    .displayName(IResolvable)
    .mountPath(java.lang.String)
    .mountPath(IResolvable)
    .workspaceId(java.lang.String)
    .workspaceId(IResolvable)
//  .codeBranch(java.lang.String)
//  .codeBranch(IResolvable)
//  .codeCommit(java.lang.String)
//  .codeCommit(IResolvable)
//  .codeRepoAccessToken(java.lang.String)
//  .codeRepoAccessToken(IResolvable)
//  .codeRepoUserName(java.lang.String)
//  .codeRepoUserName(IResolvable)
//  .description(java.lang.String)
//  .description(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.
`accessibility`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property accessibility: Visibility of the code configuration, possible values: - PRIVATE: In this workspace, it is only visible to you and the administrator.
`codeRepo`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property codeRepo: Code repository address.
`displayName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property displayName: Code source configuration name.
`mountPath`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property mountPath: The local Mount Directory of the code.
`workspaceId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property workspaceId: The ID of the workspace.
`codeBranch`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property codeBranch: Code repository branch.
`codeCommit`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property codeCommit: The code CommitId.
`codeRepoAccessToken`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property codeRepoAccessToken: The Token used to access the code repository.
`codeRepoUserName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property codeRepoUserName: The user name of the code repository.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: A detailed description of the code configuration.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`accessibility`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property accessibility: Visibility of the code configuration, possible values: - PRIVATE: In this workspace, it is only visible to you and the administrator.

PUBLIC: In this workspace, it is visible to everyone.

`codeRepo`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property codeRepo: Code repository address.

`displayName`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property displayName: Code source configuration name.

`mountPath`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property mountPath: The local Mount Directory of the code.

`workspaceId`^Required

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property workspaceId: The ID of the workspace.

`codeBranch`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property codeBranch: Code repository branch.

`codeCommit`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property codeCommit: The code CommitId.

`codeRepoAccessToken`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property codeRepoAccessToken: The Token used to access the code repository.

`codeRepoUserName`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property codeRepoUserName: The user name of the code repository.

`description`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: A detailed description of the code configuration.

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.
`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.

session^Required

Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.pai.CodeSource;
CodeSource.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`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.
`attrAccessibility`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Accessibility: Visibility of the code configuration.
`attrCodeBranch`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CodeBranch: Code repository branch.
`attrCodeCommit`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CodeCommit: The code CommitId.
`attrCodeRepo`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CodeRepo: Code repository address.
`attrCodeRepoAccessToken`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CodeRepoAccessToken: The Token used to access the code repository.
`attrCodeRepoUserName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CodeRepoUserName: The user name of the code repository.
`attrCodeSourcesId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CodeSourcesId: The ID of the created code configuration.
`attrCreateTime`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute CreateTime: The creation time of the code.
`attrDescription`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Description: A detailed description of the code configuration.
`attrDisplayName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute DisplayName: Code source configuration name.
`attrGmtModifyTime`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute GmtModifyTime: Code configuration modification time.
`attrMountPath`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute MountPath: The local Mount Directory of the code.
`attrUserId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute UserId: The ID of the creator of the code configuration source.
`attrWorkspaceId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute WorkspaceId: The ID of the workspace.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrAccessibility`^Required

public IResolvable getAttrAccessibility();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Accessibility: Visibility of the code configuration.

`attrCodeBranch`^Required

public IResolvable getAttrCodeBranch();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CodeBranch: Code repository branch.

`attrCodeCommit`^Required

public IResolvable getAttrCodeCommit();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CodeCommit: The code CommitId.

`attrCodeRepo`^Required

public IResolvable getAttrCodeRepo();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CodeRepo: Code repository address.

`attrCodeRepoAccessToken`^Required

public IResolvable getAttrCodeRepoAccessToken();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CodeRepoAccessToken: The Token used to access the code repository.

`attrCodeRepoUserName`^Required

public IResolvable getAttrCodeRepoUserName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CodeRepoUserName: The user name of the code repository.

`attrCodeSourcesId`^Required

public IResolvable getAttrCodeSourcesId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CodeSourcesId: The ID of the created code configuration.

`attrCreateTime`^Required

public IResolvable getAttrCreateTime();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time of the code.

`attrDescription`^Required

public IResolvable getAttrDescription();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: A detailed description of the code configuration.

`attrDisplayName`^Required

public IResolvable getAttrDisplayName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DisplayName: Code source configuration name.

`attrGmtModifyTime`^Required

public IResolvable getAttrGmtModifyTime();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GmtModifyTime: Code configuration modification time.

The time format is iso8601.

`attrMountPath`^Required

public IResolvable getAttrMountPath();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MountPath: The local Mount Directory of the code.

`attrUserId`^Required

public IResolvable getAttrUserId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UserId: The ID of the creator of the code configuration source.

`attrWorkspaceId`^Required

public IResolvable getAttrWorkspaceId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute WorkspaceId: The ID of the workspace.

CodeSource

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

accessibilityRequired

codeRepoRequired

displayNameRequired

mountPathRequired

workspaceIdRequired

codeBranchOptional

codeCommitOptional

codeRepoAccessTokenOptional

codeRepoUserNameOptional

descriptionOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata

Static Functions

isConstruct