CreateBranchRequest (AWS SDK for Java

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`	`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.
`Boolean`	`enableAutoBuild()` Enables auto building for the branch.
`Boolean`	`enableBasicAuth()` Enables Basic Auth for the branch.
`Boolean`	`enableNotification()` Enables notifications for the branch.
`Map<String,String>`	`environmentVariables()` Environment Variables for the branch.
`boolean`	`equals(Object obj)`
`String`	`framework()` Framework for the branch.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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
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.
  - 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.
    
    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.
  - tags
```
public Map<String,String> tags()
```
    Tag for the branch.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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.
  - toBuilder
```
public CreateBranchRequest.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<CreateBranchRequest.Builder,CreateBranchRequest>
    
    Specified by:
    
    toBuilder in class AmplifyRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateBranchRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBranchRequest.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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - 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 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

environmentVariables

basicAuthCredentials

enableBasicAuth

tags

buildSpec

ttl

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields