Branch.Builder (AWS Java SDK :: Services

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Branch.Builder`	`activeJobId(String activeJobId)` The ID of the active job for a branch of an Amplify app.
`Branch.Builder`	`associatedResources(Collection<String> associatedResources)` A list of custom resources that are linked to this branch.
`Branch.Builder`	`associatedResources(String... associatedResources)` A list of custom resources that are linked to this branch.
`Branch.Builder`	`backendEnvironmentArn(String backendEnvironmentArn)` The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
`Branch.Builder`	`basicAuthCredentials(String basicAuthCredentials)` The basic authorization credentials for a branch of an Amplify app.
`Branch.Builder`	`branchArn(String branchArn)` The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
`Branch.Builder`	`branchName(String branchName)` The name for the branch that is part of an Amplify app.
`Branch.Builder`	`buildSpec(String buildSpec)` The build specification (build spec) content for the branch of an Amplify app.
`Branch.Builder`	`createTime(Instant createTime)` The creation date and time for a branch that is part of an Amplify app.
`Branch.Builder`	`customDomains(Collection<String> customDomains)` The custom domains for a branch of an Amplify app.
`Branch.Builder`	`customDomains(String... customDomains)` The custom domains for a branch of an Amplify app.
`Branch.Builder`	`description(String description)` The description for the branch that is 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)` The display name for the branch.
`Branch.Builder`	`enableAutoBuild(Boolean enableAutoBuild)` Enables auto-building on push for a branch of an Amplify app.
`Branch.Builder`	`enableBasicAuth(Boolean enableBasicAuth)` Enables basic authorization for a branch of an Amplify app.
`Branch.Builder`	`enableNotification(Boolean enableNotification)` Enables notifications for a branch that is part of an Amplify app.
`Branch.Builder`	`enablePerformanceMode(Boolean enablePerformanceMode)` Enables performance mode for the branch.
`Branch.Builder`	`enablePullRequestPreview(Boolean enablePullRequestPreview)` Enables pull request previews for the branch.
`Branch.Builder`	`environmentVariables(Map<String,String> environmentVariables)` The environment variables specific to a branch of an Amplify app.
`Branch.Builder`	`framework(String framework)` The framework for a branch 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)` The current stage for the branch that is part of an Amplify app.
`Branch.Builder`	`stage(String stage)` The current stage for the branch that is part of an Amplify app.
`Branch.Builder`	`tags(Map<String,String> tags)` The tag for the branch of an Amplify app.
`Branch.Builder`	`thumbnailUrl(String thumbnailUrl)` The thumbnail URL for the branch of an Amplify app.
`Branch.Builder`	`totalNumberOfJobs(String totalNumberOfJobs)` The total number of jobs that are part of an Amplify app.
`Branch.Builder`	`ttl(String ttl)` The content Time to Live (TTL) for the website in seconds.
`Branch.Builder`	`updateTime(Instant updateTime)` The last updated date and time for a branch that is 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)
```
    The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
    
    Parameters:
    
    branchArn - The Amazon Resource Name (ARN) for a branch that is 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)
```
    The name for the branch that is part of an Amplify app.
    
    Parameters:
    
    branchName - The name for the branch that is 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)
```
    The description for the branch that is part of an Amplify app.
    
    Parameters:
    
    description - The description for the branch that is 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)
```
    The tag for the branch of an Amplify app.
    
    Parameters:
    
    tags - The tag for the branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - stage
```
Branch.Builder stage(String stage)
```
    The current stage for the branch that is part of an Amplify app.
    
    Parameters:
    
    stage - The current stage for the branch that is 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)
```
    The current stage for the branch that is part of an Amplify app.
    
    Parameters:
    
    stage - The current stage for the branch that is 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)
```
    The display name for the branch. This is used as the default domain prefix.
    
    Parameters:
    
    displayName - The display name for the branch. This is used 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 that is part of an Amplify app.
    
    Parameters:
    
    enableNotification - Enables notifications for a branch that is 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)
```
    The creation date and time for a branch that is part of an Amplify app.
    
    Parameters:
    
    createTime - The creation date and time for a branch that is 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)
```
    The last updated date and time for a branch that is part of an Amplify app.
    
    Parameters:
    
    updateTime - The last updated date and time for a branch that is 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)
```
    The environment variables specific to a branch of an Amplify app.
    
    Parameters:
    
    environmentVariables - The environment variables specific to a branch 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 of an Amplify app.
    
    Parameters:
    
    enableAutoBuild - Enables auto-building on push for a branch 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)
```
    The custom domains for a branch of an Amplify app.
    
    Parameters:
    
    customDomains - The custom domains for a branch 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)
```
    The custom domains for a branch of an Amplify app.
    
    Parameters:
    
    customDomains - The custom domains for a branch 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)
```
    The framework for a branch of an Amplify app.
    
    Parameters:
    
    framework - The framework for a branch 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)
```
    The ID of the active job for a branch of an Amplify app.
    
    Parameters:
    
    activeJobId - The ID of the active job for a branch 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)
```
    The total number of jobs that are part of an Amplify app.
    
    Parameters:
    
    totalNumberOfJobs - The total number of jobs that are 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 of an Amplify app.
    
    Parameters:
    
    enableBasicAuth - Enables basic authorization for a branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enablePerformanceMode
```
Branch.Builder enablePerformanceMode(Boolean enablePerformanceMode)
```
    Enables performance mode for the branch.
    
    Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
    
    Parameters:
    
    enablePerformanceMode - Enables performance mode for the branch.
    
    Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - thumbnailUrl
```
Branch.Builder thumbnailUrl(String thumbnailUrl)
```
    The thumbnail URL for the branch of an Amplify app.
    
    Parameters:
    
    thumbnailUrl - The thumbnail URL for the branch of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - basicAuthCredentials
```
Branch.Builder basicAuthCredentials(String basicAuthCredentials)
```
    The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    
    Parameters:
    
    basicAuthCredentials - The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - buildSpec
```
Branch.Builder buildSpec(String buildSpec)
```
    The build specification (build spec) content for the branch of an Amplify app.
    
    Parameters:
    
    buildSpec - The build specification (build spec) content for the branch of an 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 Time to Live (TTL) for the website in seconds.
    
    Parameters:
    
    ttl - The content Time to Live (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)
```
    A list of custom resources that are linked to this branch.
    
    Parameters:
    
    associatedResources - A 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)
```
    A list of custom resources that are linked to this branch.
    
    Parameters:
    
    associatedResources - A 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 previews for the branch.
    
    Parameters:
    
    enablePullRequestPreview - Enables pull request previews for the 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)
```
    The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    Parameters:
    
    backendEnvironmentArn - The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface Branch.Builder

Method Summary

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

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

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

Method Detail

branchArn

branchName

description

tags

stage

stage

displayName

enableNotification

createTime

updateTime

environmentVariables

enableAutoBuild

customDomains

customDomains

framework

activeJobId

totalNumberOfJobs

enableBasicAuth

enablePerformanceMode

thumbnailUrl

basicAuthCredentials

buildSpec

ttl

associatedResources

associatedResources

enablePullRequestPreview

pullRequestEnvironmentName

destinationBranch

sourceBranch

backendEnvironmentArn