software.amazon.awssdk.services.amplify.model

Interface Branch.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Branch.Builder,Branch>, SdkBuilder<Branch.Builder,Branch>, SdkPojo

Enclosing class:

Branch

public static interface Branch.Builder
extends SdkPojo, CopyableBuilder<Branch.Builder,Branch>

Method Summary

Modifier and Type	Method and Description
Branch.Builder	activeJobId(String activeJobId) Id of the active job for a branch, part of an Amplify App.
Branch.Builder	associatedResources(Collection<String> associatedResources) List of custom resources that are linked to this branch.
Branch.Builder	associatedResources(String... associatedResources) List of custom resources that are linked to this branch.
Branch.Builder	backendEnvironmentArn(String backendEnvironmentArn) ARN for a Backend Environment, part of an Amplify App.
Branch.Builder	basicAuthCredentials(String basicAuthCredentials) Basic Authorization credentials for a branch, part of an Amplify App.
Branch.Builder	branchArn(String branchArn) ARN for a branch, part of an Amplify App.
Branch.Builder	branchName(String branchName) Name for a branch, part of an Amplify App.
Branch.Builder	buildSpec(String buildSpec) BuildSpec content for branch for Amplify App.
Branch.Builder	createTime(Instant createTime) Creation date and time for a branch, part of an Amplify App.
Branch.Builder	customDomains(Collection<String> customDomains) Custom domains for a branch, part of an Amplify App.
Branch.Builder	customDomains(String... customDomains) Custom domains for a branch, part of an Amplify App.
Branch.Builder	description(String description) Description for a branch, part of an Amplify App.
Branch.Builder	destinationBranch(String destinationBranch) The destination branch if the branch is a pull request branch.
Branch.Builder	displayName(String displayName) Display name for a branch, will use as the default domain prefix.
Branch.Builder	enableAutoBuild(Boolean enableAutoBuild) Enables auto-building on push for a branch, part of an Amplify App.
Branch.Builder	enableBasicAuth(Boolean enableBasicAuth) Enables Basic Authorization for a branch, part of an Amplify App.
Branch.Builder	enableNotification(Boolean enableNotification) Enables notifications for a branch, part of an Amplify App.
Branch.Builder	enablePullRequestPreview(Boolean enablePullRequestPreview) Enables Pull Request Preview for this branch.
Branch.Builder	environmentVariables(Map<String,String> environmentVariables) Environment Variables specific to a branch, part of an Amplify App.
Branch.Builder	framework(String framework) Framework for a branch, part of an Amplify App.
Branch.Builder	pullRequestEnvironmentName(String pullRequestEnvironmentName) The Amplify Environment name for the pull request.
Branch.Builder	sourceBranch(String sourceBranch) The source branch if the branch is a pull request branch.
Branch.Builder	stage(Stage stage) Stage for a branch, part of an Amplify App.
Branch.Builder	stage(String stage) Stage for a branch, part of an Amplify App.
Branch.Builder	tags(Map<String,String> tags) Tag for branch for Amplify App.
Branch.Builder	thumbnailUrl(String thumbnailUrl) Thumbnail URL for the branch.
Branch.Builder	totalNumberOfJobs(String totalNumberOfJobs) Total number of Jobs part of an Amplify App.
Branch.Builder	ttl(String ttl) The content TTL for the website in seconds.
Branch.Builder	updateTime(Instant updateTime) Last updated date and time for a branch, part of an Amplify App.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

branchArn

Branch.Builder branchArn(String branchArn)

ARN for a branch, part of an Amplify App.

Parameters:

branchArn - ARN for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

branchName

Branch.Builder branchName(String branchName)

Name for a branch, part of an Amplify App.

Parameters:

branchName - Name for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

Branch.Builder description(String description)

Description for a branch, part of an Amplify App.

Parameters:

description - Description for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

Branch.Builder tags(Map<String,String> tags)

Tag for branch for Amplify App.

Parameters:

tags - Tag for branch for Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

stage

Branch.Builder stage(String stage)

Stage for a branch, part of an Amplify App.

Parameters:

stage - Stage for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Stage, Stage

stage

Branch.Builder stage(Stage stage)

Stage for a branch, part of an Amplify App.

Parameters:

stage - Stage for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Stage, Stage

displayName

Branch.Builder displayName(String displayName)

Display name for a branch, will use as the default domain prefix.

Parameters:

displayName - Display name for a branch, will use as the default domain prefix.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableNotification

Branch.Builder enableNotification(Boolean enableNotification)

Enables notifications for a branch, part of an Amplify App.

Parameters:

enableNotification - Enables notifications for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

createTime

Branch.Builder createTime(Instant createTime)

Creation date and time for a branch, part of an Amplify App.

Parameters:

createTime - Creation date and time for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

updateTime

Branch.Builder updateTime(Instant updateTime)

Last updated date and time for a branch, part of an Amplify App.

Parameters:

updateTime - Last updated date and time for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentVariables

Branch.Builder environmentVariables(Map<String,String> environmentVariables)

Environment Variables specific to a branch, part of an Amplify App.

Parameters:

environmentVariables - Environment Variables specific to a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableAutoBuild

Branch.Builder enableAutoBuild(Boolean enableAutoBuild)

Enables auto-building on push for a branch, part of an Amplify App.

Parameters:

enableAutoBuild - Enables auto-building on push for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

customDomains

Branch.Builder customDomains(Collection<String> customDomains)

Custom domains for a branch, part of an Amplify App.

Parameters:

customDomains - Custom domains for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

customDomains

Branch.Builder customDomains(String... customDomains)

Custom domains for a branch, part of an Amplify App.

Parameters:

customDomains - Custom domains for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

framework

Branch.Builder framework(String framework)

Framework for a branch, part of an Amplify App.

Parameters:

framework - Framework for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

activeJobId

Branch.Builder activeJobId(String activeJobId)

Id of the active job for a branch, part of an Amplify App.

Parameters:

activeJobId - Id of the active job for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

totalNumberOfJobs

Branch.Builder totalNumberOfJobs(String totalNumberOfJobs)

Total number of Jobs part of an Amplify App.

Parameters:

totalNumberOfJobs - Total number of Jobs part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableBasicAuth

Branch.Builder enableBasicAuth(Boolean enableBasicAuth)

Enables Basic Authorization for a branch, part of an Amplify App.

Parameters:

enableBasicAuth - Enables Basic Authorization for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

thumbnailUrl

Branch.Builder thumbnailUrl(String thumbnailUrl)

Thumbnail URL for the branch.

Parameters:

thumbnailUrl - Thumbnail URL for the branch.

Returns:

Returns a reference to this object so that method calls can be chained together.

basicAuthCredentials

Branch.Builder basicAuthCredentials(String basicAuthCredentials)

Basic Authorization credentials for a branch, part of an Amplify App.

Parameters:

basicAuthCredentials - Basic Authorization credentials for a branch, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

buildSpec

Branch.Builder buildSpec(String buildSpec)

BuildSpec content for branch for Amplify App.

Parameters:

buildSpec - BuildSpec content for branch for Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

ttl

Branch.Builder ttl(String ttl)

The content TTL for the website in seconds.

Parameters:

ttl - The content TTL for the website in seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

associatedResources

Branch.Builder associatedResources(Collection<String> associatedResources)

List of custom resources that are linked to this branch.

Parameters:

associatedResources - List of custom resources that are linked to this branch.

Returns:

Returns a reference to this object so that method calls can be chained together.

associatedResources

Branch.Builder associatedResources(String... associatedResources)

List of custom resources that are linked to this branch.

Parameters:

associatedResources - List of custom resources that are linked to this branch.

Returns:

Returns a reference to this object so that method calls can be chained together.

enablePullRequestPreview

Branch.Builder enablePullRequestPreview(Boolean enablePullRequestPreview)

Enables Pull Request Preview for this branch.

Parameters:

enablePullRequestPreview - Enables Pull Request Preview for this branch.

Returns:

Returns a reference to this object so that method calls can be chained together.

pullRequestEnvironmentName

Branch.Builder pullRequestEnvironmentName(String pullRequestEnvironmentName)

The Amplify Environment name for the pull request.

Parameters:

pullRequestEnvironmentName - The Amplify Environment name for the pull request.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationBranch

Branch.Builder destinationBranch(String destinationBranch)

The destination branch if the branch is a pull request branch.

Parameters:

destinationBranch - The destination branch if the branch is a pull request branch.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceBranch

Branch.Builder sourceBranch(String sourceBranch)

The source branch if the branch is a pull request branch.

Parameters:

sourceBranch - The source branch if the branch is a pull request branch.

Returns:

Returns a reference to this object so that method calls can be chained together.

backendEnvironmentArn

Branch.Builder backendEnvironmentArn(String backendEnvironmentArn)

ARN for a Backend Environment, part of an Amplify App.

Parameters:

backendEnvironmentArn - ARN for a Backend Environment, part of an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.