Branch (AWS SDK for Java

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.
`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`	`displayName()` Display name for a branch, part of an Amplify App.
`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.
`Map<String,String>`	`environmentVariables()` Environment Variables specific to a branch, part of an Amplify App.
`boolean`	`equals(Object obj)`
`String`	`framework()` Framework for a branch, part of an Amplify App.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Branch.Builder>`	`serializableBuilderClass()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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
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.
  - 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.
    
    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, part of an Amplify App.
    
    Returns:
    
    Display name for a branch, part of an Amplify App.
  - 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.
  - 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.
    
    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.
  - 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.
    
    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.
  - toBuilder
```
public Branch.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Branch.Builder,Branch>
    
    Returns:
    
    a builder for type T
  - 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
  - toString
```
public String toString()
```
    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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

tags

stage

stageAsString

displayName

enableNotification

createTime

updateTime

environmentVariables

enableAutoBuild

customDomains

framework

activeJobId

totalNumberOfJobs

enableBasicAuth

thumbnailUrl

basicAuthCredentials

buildSpec

ttl

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields