Branch class
The branch for an Amplify app, which maps to a third-party repository branch.
Constructors
-
Branch({required String activeJobId, required String branchArn, required String branchName, required DateTime createTime, required List<
String> customDomains, required String description, required String displayName, required bool enableAutoBuild, required bool enableBasicAuth, required bool enableNotification, required bool enablePullRequestPreview, required Map<String, String> environmentVariables, required String framework, required Stage stage, required String totalNumberOfJobs, required String ttl, required DateTime updateTime, List<String> ? associatedResources, String? backendEnvironmentArn, String? basicAuthCredentials, String? buildSpec, String? destinationBranch, bool? enablePerformanceMode, String? pullRequestEnvironmentName, String? sourceBranch, Map<String, String> ? tags, String? thumbnailUrl}) -
Branch.fromJson(Map<
String, dynamic> json) -
factory
Properties
- activeJobId → String
-
The ID of the active job for a branch of an Amplify app.
final
-
associatedResources
→ List<
String> ? -
A list of custom resources that are linked to this branch.
final
- backendEnvironmentArn → String?
-
The Amazon Resource Name (ARN) for a backend environment that is part of an
Amplify app.
final
- basicAuthCredentials → String?
-
The basic authorization credentials for a branch of an Amplify app.
final
- branchArn → String
-
The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
final
- branchName → String
-
The name for the branch that is part of an Amplify app.
final
- buildSpec → String?
-
The build specification (build spec) content for the branch of an Amplify
app.
final
- createTime → DateTime
-
The creation date and time for a branch that is part of an Amplify app.
final
-
customDomains
→ List<
String> -
The custom domains for a branch of an Amplify app.
final
- description → String
-
The description for the branch that is part of an Amplify app.
final
- destinationBranch → String?
-
The destination branch if the branch is a pull request branch.
final
- displayName → String
-
The display name for the branch. This is used as the default domain prefix.
final
- enableAutoBuild → bool
-
Enables auto-building on push for a branch of an Amplify app.
final
- enableBasicAuth → bool
-
Enables basic authorization for a branch of an Amplify app.
final
- enableNotification → bool
-
Enables notifications for a branch that is part of an Amplify app.
final
- enablePerformanceMode → bool?
-
Enables performance mode for the branch.
final
- enablePullRequestPreview → bool
-
Enables pull request previews for the branch.
final
-
environmentVariables
→ Map<
String, String> -
The environment variables specific to a branch of an Amplify app.
final
- framework → String
-
The framework for a branch of an Amplify app.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- pullRequestEnvironmentName → String?
-
The Amplify environment name for the pull request.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sourceBranch → String?
-
The source branch if the branch is a pull request branch.
final
- stage → Stage
-
The current stage for the branch that is part of an Amplify app.
final
-
The tag for the branch of an Amplify app.
final
- thumbnailUrl → String?
-
The thumbnail URL for the branch of an Amplify app.
final
- totalNumberOfJobs → String
-
The total number of jobs that are part of an Amplify app.
final
- ttl → String
-
The content Time to Live (TTL) for the website in seconds.
final
- updateTime → DateTime
-
The last updated date and time for a branch that is part of an Amplify app.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited