software.amazon.awssdk.services.codecommit.model

Class GetFolderRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codecommit.model.CodeCommitRequest

software.amazon.awssdk.services.codecommit.model.GetFolderRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFolderRequest.Builder,GetFolderRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetFolderRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetFolderRequest.Builder	builder()
String	commitSpecifier() A fully-qualified reference used to identify a commit that contains the version of the folder's content to return.
boolean	equals(Object obj)
String	folderPath() The fully-qualified path to the folder whose contents will be returned, including the folder name.
<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()
String	repositoryName() The name of the repository.
List<SdkField<?>>	sdkFields()
static Class<? extends GetFolderRequest.Builder>	serializableBuilderClass()
GetFolderRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

repositoryName

public String repositoryName()

The name of the repository.

Returns:

The name of the repository.

commitSpecifier

public String commitSpecifier()

A fully-qualified reference used to identify a commit that contains the version of the folder's content to return. A fully-qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content will be returned as it exists in the HEAD commit.

Returns:

A fully-qualified reference used to identify a commit that contains the version of the folder's content to return. A fully-qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content will be returned as it exists in the HEAD commit.

folderPath

public String folderPath()

The fully-qualified path to the folder whose contents will be returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

Returns:

The fully-qualified path to the folder whose contents will be returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

toBuilder

public GetFolderRequest.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<GetFolderRequest.Builder,GetFolderRequest>

Specified by:

toBuilder in class CodeCommitRequest

Returns:

a builder for type T

builder

public static GetFolderRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetFolderRequest.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.