CreateBranchRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.amplify.model.AmplifyRequest
    - - software.amazon.awssdk.services.amplify.model.CreateBranchRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBranchRequest
extends AmplifyRequest
implements ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>

Request structure for a branch create request.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateBranchRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`appId()` Unique Id for an Amplify App.
`String`	`backendEnvironmentArn()` ARN for a Backend Environment, part of an Amplify App.
`String`	`basicAuthCredentials()` Basic Authorization credentials for the branch.
`String`	`branchName()` Name for the branch.
`static CreateBranchRequest.Builder`	`builder()`
`String`	`buildSpec()` BuildSpec for the branch.
`String`	`description()` Description for the branch.
`String`	`displayName()` Display name for a branch, will use as the default domain prefix.
`Boolean`	`enableAutoBuild()` Enables auto building for the branch.
`Boolean`	`enableBasicAuth()` Enables Basic Auth for the branch.
`Boolean`	`enableNotification()` Enables notifications for the branch.
`Boolean`	`enablePullRequestPreview()` Enables Pull Request Preview for this branch.
`Map<String,String>`	`environmentVariables()` Environment Variables for the branch.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`framework()` Framework for the branch.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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 CreateBranchRequest.Builder>`	`serializableBuilderClass()`
`Stage`	`stage()` Stage for the branch.
`String`	`stageAsString()` Stage for the branch.
`Map<String,String>`	`tags()` Tag for the branch.
`CreateBranchRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`ttl()` The content TTL for the website in seconds.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - appId
```
public String appId()
```
    Unique Id for an Amplify App.
    
    Returns:
    
    Unique Id for an Amplify App.
  - branchName
```
public String branchName()
```
    Name for the branch.
    
    Returns:
    
    Name for the branch.
  - description
```
public String description()
```
    Description for the branch.
    
    Returns:
    
    Description for the branch.
  - stage
```
public Stage stage()
```
    Stage for the branch.
    
    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 the branch.
    
    See Also:
    
    Stage
  - stageAsString
```
public String stageAsString()
```
    Stage for the branch.
    
    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 the branch.
    
    See Also:
    
    Stage
  - framework
```
public String framework()
```
    Framework for the branch.
    
    Returns:
    
    Framework for the branch.
  - enableNotification
```
public Boolean enableNotification()
```
    Enables notifications for the branch.
    
    Returns:
    
    Enables notifications for the branch.
  - enableAutoBuild
```
public Boolean enableAutoBuild()
```
    Enables auto building for the branch.
    
    Returns:
    
    Enables auto building for the branch.
  - 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 for the branch.
    
    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 for the branch.
  - basicAuthCredentials
```
public String basicAuthCredentials()
```
    Basic Authorization credentials for the branch.
    
    Returns:
    
    Basic Authorization credentials for the branch.
  - enableBasicAuth
```
public Boolean enableBasicAuth()
```
    Enables Basic Auth for the branch.
    
    Returns:
    
    Enables Basic Auth for the branch.
  - 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 the branch.
    
    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 the branch.
  - buildSpec
```
public String buildSpec()
```
    BuildSpec for the branch.
    
    Returns:
    
    BuildSpec for the branch.
  - ttl
```
public String ttl()
```
    The content TTL for the website in seconds.
    
    Returns:
    
    The content TTL for the website in seconds.
  - 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.
  - 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.
  - 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 CreateBranchRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>
    
    Specified by:
    
    toBuilder in class AmplifyRequest
  - builder
```
public static CreateBranchRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBranchRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateBranchRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

appId

branchName

description

stage

stageAsString

framework

enableNotification

enableAutoBuild

hasEnvironmentVariables

environmentVariables

basicAuthCredentials

enableBasicAuth

hasTags

tags

buildSpec

ttl

displayName

enablePullRequestPreview

pullRequestEnvironmentName

backendEnvironmentArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields