Branch (AWS Java SDK :: Services :: Amplify 2.10.38 API)

java.lang.Object
- software.amazon.awssdk.services.amplify.model.Branch

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Branch.Builder,Branch>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Branch
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Branch.Builder,Branch>
```
Branch for an Amplify App, which maps to a 3rd party repository branch.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Branch.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Branch.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`activeJobId()` Id of the active job for a branch, part of an Amplify App.
`List<String>`	`associatedResources()` List of custom resources that are linked to this branch.
`String`	`backendEnvironmentArn()` ARN for a Backend Environment, part of an Amplify App.
`String`	`basicAuthCredentials()` Basic Authorization credentials for a branch, part of an Amplify App.
`String`	`branchArn()` ARN for a branch, part of an Amplify App.
`String`	`branchName()` Name for a branch, part of an Amplify App.
`static Branch.Builder`	`builder()`
`String`	`buildSpec()` BuildSpec content for branch for Amplify App.
`Instant`	`createTime()` Creation date and time for a branch, part of an Amplify App.
`List<String>`	`customDomains()` Custom domains for a branch, part of an Amplify App.
`String`	`description()` Description for a branch, part of an Amplify App.
`String`	`destinationBranch()` The destination branch if the branch is a pull request branch.
`String`	`displayName()` Display name for a branch, will use as the default domain prefix.
`Boolean`	`enableAutoBuild()` Enables auto-building on push for a branch, part of an Amplify App.
`Boolean`	`enableBasicAuth()` Enables Basic Authorization for a branch, part of an Amplify App.
`Boolean`	`enableNotification()` Enables notifications for a branch, part of an Amplify App.
`Boolean`	`enablePullRequestPreview()` Enables Pull Request Preview for this branch.
`Map<String,String>`	`environmentVariables()` Environment Variables specific to a branch, part of an Amplify App.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`framework()` Framework for a branch, part of an Amplify App.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssociatedResources()` Returns true if the AssociatedResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasCustomDomains()` Returns true if the CustomDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnvironmentVariables()` Returns true if the EnvironmentVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`pullRequestEnvironmentName()` The Amplify Environment name for the pull request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Branch.Builder>`	`serializableBuilderClass()`
`String`	`sourceBranch()` The source branch if the branch is a pull request branch.
`Stage`	`stage()` Stage for a branch, part of an Amplify App.
`String`	`stageAsString()` Stage for a branch, part of an Amplify App.
`Map<String,String>`	`tags()` Tag for branch for Amplify App.
`String`	`thumbnailUrl()` Thumbnail URL for the branch.
`Branch.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`totalNumberOfJobs()` Total number of Jobs part of an Amplify App.
`String`	`ttl()` The content TTL for the website in seconds.
`Instant`	`updateTime()` Last updated date and time for a branch, part of an Amplify App.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - branchArn
```
public String branchArn()
```
    ARN for a branch, part of an Amplify App.
    
    Returns:
    
    ARN for a branch, part of an Amplify App.
  - branchName
```
public String branchName()
```
    Name for a branch, part of an Amplify App.
    
    Returns:
    
    Name for a branch, part of an Amplify App.
  - description
```
public String description()
```
    Description for a branch, part of an Amplify App.
    
    Returns:
    
    Description for a branch, part of an Amplify App.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> tags()
```
    Tag for branch for Amplify App.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Tag for branch for Amplify App.
  - stage
```
public Stage stage()
```
    Stage for a branch, part of an Amplify App.
    
    If the service returns an enum value that is not available in the current SDK version, stage will return Stage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stageAsString().
    
    Returns:
    
    Stage for a branch, part of an Amplify App.
    
    See Also:
    
    Stage
  - stageAsString
```
public String stageAsString()
```
    Stage for a branch, part of an Amplify App.
    
    If the service returns an enum value that is not available in the current SDK version, stage will return Stage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stageAsString().
    
    Returns:
    
    Stage for a branch, part of an Amplify App.
    
    See Also:
    
    Stage
  - displayName
```
public String displayName()
```
    Display name for a branch, will use as the default domain prefix.
    
    Returns:
    
    Display name for a branch, will use as the default domain prefix.
  - enableNotification
```
public Boolean enableNotification()
```
    Enables notifications for a branch, part of an Amplify App.
    
    Returns:
    
    Enables notifications for a branch, part of an Amplify App.
  - createTime
```
public Instant createTime()
```
    Creation date and time for a branch, part of an Amplify App.
    
    Returns:
    
    Creation date and time for a branch, part of an Amplify App.
  - updateTime
```
public Instant updateTime()
```
    Last updated date and time for a branch, part of an Amplify App.
    
    Returns:
    
    Last updated date and time for a branch, part of an Amplify App.
  - hasEnvironmentVariables
```
public boolean hasEnvironmentVariables()
```
    Returns true if the EnvironmentVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - environmentVariables
```
public Map<String,String> environmentVariables()
```
    Environment Variables specific to a branch, part of an Amplify App.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEnvironmentVariables() to see if a value was sent in this field.
    
    Returns:
    
    Environment Variables specific to a branch, part of an Amplify App.
  - enableAutoBuild
```
public Boolean enableAutoBuild()
```
    Enables auto-building on push for a branch, part of an Amplify App.
    
    Returns:
    
    Enables auto-building on push for a branch, part of an Amplify App.
  - hasCustomDomains
```
public boolean hasCustomDomains()
```
    Returns true if the CustomDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - customDomains
```
public List<String> customDomains()
```
    Custom domains for a branch, part of an Amplify App.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCustomDomains() to see if a value was sent in this field.
    
    Returns:
    
    Custom domains for a branch, part of an Amplify App.
  - framework
```
public String framework()
```
    Framework for a branch, part of an Amplify App.
    
    Returns:
    
    Framework for a branch, part of an Amplify App.
  - activeJobId
```
public String activeJobId()
```
    Id of the active job for a branch, part of an Amplify App.
    
    Returns:
    
    Id of the active job for a branch, part of an Amplify App.
  - totalNumberOfJobs
```
public String totalNumberOfJobs()
```
    Total number of Jobs part of an Amplify App.
    
    Returns:
    
    Total number of Jobs part of an Amplify App.
  - enableBasicAuth
```
public Boolean enableBasicAuth()
```
    Enables Basic Authorization for a branch, part of an Amplify App.
    
    Returns:
    
    Enables Basic Authorization for a branch, part of an Amplify App.
  - thumbnailUrl
```
public String thumbnailUrl()
```
    Thumbnail URL for the branch.
    
    Returns:
    
    Thumbnail URL for the branch.
  - basicAuthCredentials
```
public String basicAuthCredentials()
```
    Basic Authorization credentials for a branch, part of an Amplify App.
    
    Returns:
    
    Basic Authorization credentials for a branch, part of an Amplify App.
  - buildSpec
```
public String buildSpec()
```
    BuildSpec content for branch for Amplify App.
    
    Returns:
    
    BuildSpec content for branch for Amplify App.
  - ttl
```
public String ttl()
```
    The content TTL for the website in seconds.
    
    Returns:
    
    The content TTL for the website in seconds.
  - hasAssociatedResources
```
public boolean hasAssociatedResources()
```
    Returns true if the AssociatedResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - associatedResources
```
public List<String> associatedResources()
```
    List of custom resources that are linked to this branch.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAssociatedResources() to see if a value was sent in this field.
    
    Returns:
    
    List of custom resources that are linked to this branch.
  - enablePullRequestPreview
```
public Boolean enablePullRequestPreview()
```
    Enables Pull Request Preview for this branch.
    
    Returns:
    
    Enables Pull Request Preview for this branch.
  - pullRequestEnvironmentName
```
public String pullRequestEnvironmentName()
```
    The Amplify Environment name for the pull request.
    
    Returns:
    
    The Amplify Environment name for the pull request.
  - destinationBranch
```
public String destinationBranch()
```
    The destination branch if the branch is a pull request branch.
    
    Returns:
    
    The destination branch if the branch is a pull request branch.
  - sourceBranch
```
public String sourceBranch()
```
    The source branch if the branch is a pull request branch.
    
    Returns:
    
    The source branch if the branch is a pull request branch.
  - backendEnvironmentArn
```
public String backendEnvironmentArn()
```
    ARN for a Backend Environment, part of an Amplify App.
    
    Returns:
    
    ARN for a Backend Environment, part of an Amplify App.
  - toBuilder
```
public Branch.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Branch.Builder,Branch>
  - builder
```
public static Branch.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Branch.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Branch

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

branchArn

branchName

description

hasTags

tags

stage

stageAsString

displayName

enableNotification

createTime

updateTime

hasEnvironmentVariables

environmentVariables

enableAutoBuild

hasCustomDomains

customDomains

framework

activeJobId

totalNumberOfJobs

enableBasicAuth

thumbnailUrl

basicAuthCredentials

buildSpec

ttl

hasAssociatedResources

associatedResources

enablePullRequestPreview

pullRequestEnvironmentName

destinationBranch

sourceBranch

backendEnvironmentArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields