ImmutableDirectoryListingParams (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.cohesity.iaas.backups.recovery.model.ImmutableDirectoryListingParams

All Implemented Interfaces:: DirectoryListingParams

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableDirectoryListingParams
extends Object
implements DirectoryListingParams

Immutable implementation of DirectoryListingParams.

Use the builder to create immutable instances: ImmutableDirectoryListingParams.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableDirectoryListingParams.Builder
Builds instances of type ImmutableDirectoryListingParams.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableDirectoryListingParams.Builder` Builds instances of type `ImmutableDirectoryListingParams`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`attemptNumber()` The snapshot attempt number.
`BackupRunUid`	`backupRunUid()` The UID of the backup run.
`boolean`	`browseIndexedData()` Whether to use index data for listing.
`static ImmutableDirectoryListingParams.Builder`	`builder()` Creates a builder for `ImmutableDirectoryListingParams`.
`static ImmutableDirectoryListingParams`	`copyOf(DirectoryListingParams instance)` Creates an immutable copy of a `DirectoryListingParams` value.
`String`	`directoryPath()` The full directory path.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableDirectoryListingParams` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `backupRunUid`, `vmUuid`, `volumeName`, `directoryPath`, `attemptNumber`, `paginationCookie`, `maxEntries`, `statFileEntries`, `browseIndexedData`.
`Optional<Integer>`	`maxEntries()` The maximum number of entries to return.
`Optional<String>`	`paginationCookie()` Cookie param to be used for pagination when all results don't fit on a single page.
`boolean`	`statFileEntries()` Whether to return stat info for file entries.
`String`	`toString()` Prints the immutable value `DirectoryListingParams` with attribute values.
`VmUuid`	`vmUuid()` The UUID of the VM.
`String`	`volumeName()` The name of the associated volume.
`ImmutableDirectoryListingParams`	`withAttemptNumber(int value)` Copy the current immutable object by setting a value for the `attemptNumber` attribute.
`ImmutableDirectoryListingParams`	`withBackupRunUid(BackupRunUid value)` Copy the current immutable object by setting a value for the `backupRunUid` attribute.
`ImmutableDirectoryListingParams`	`withBrowseIndexedData(boolean value)` Copy the current immutable object by setting a value for the `browseIndexedData` attribute.
`ImmutableDirectoryListingParams`	`withDirectoryPath(String value)` Copy the current immutable object by setting a value for the `directoryPath` attribute.
`ImmutableDirectoryListingParams`	`withMaxEntries(int value)` Copy the current immutable object by setting a present value for the optional `maxEntries` attribute.
`ImmutableDirectoryListingParams`	`withMaxEntries(Optional<Integer> optional)` Copy the current immutable object by setting an optional value for the `maxEntries` attribute.
`ImmutableDirectoryListingParams`	`withPaginationCookie(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `paginationCookie` attribute.
`ImmutableDirectoryListingParams`	`withPaginationCookie(String value)` Copy the current immutable object by setting a present value for the optional `paginationCookie` attribute.
`ImmutableDirectoryListingParams`	`withStatFileEntries(boolean value)` Copy the current immutable object by setting a value for the `statFileEntries` attribute.
`ImmutableDirectoryListingParams`	`withVmUuid(VmUuid value)` Copy the current immutable object by setting a value for the `vmUuid` attribute.
`ImmutableDirectoryListingParams`	`withVolumeName(String value)` Copy the current immutable object by setting a value for the `volumeName` attribute.

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

- Method Detail
  - backupRunUid
```
public BackupRunUid backupRunUid()
```
    The UID of the backup run.
    
    Specified by:
    
    backupRunUid in interface DirectoryListingParams
  - vmUuid
```
public VmUuid vmUuid()
```
    The UUID of the VM.
    
    Specified by:
    
    vmUuid in interface DirectoryListingParams
  - volumeName
```
public String volumeName()
```
    The name of the associated volume.
    
    Specified by:
    
    volumeName in interface DirectoryListingParams
  - directoryPath
```
public String directoryPath()
```
    The full directory path.
    
    Specified by:
    
    directoryPath in interface DirectoryListingParams
  - attemptNumber
```
public int attemptNumber()
```
    The snapshot attempt number.
    
    Specified by:
    
    attemptNumber in interface DirectoryListingParams
  - paginationCookie
```
public Optional<String> paginationCookie()
```
    Cookie param to be used for pagination when all results don't fit on a single page.
    
    Specified by:
    
    paginationCookie in interface DirectoryListingParams
  - maxEntries
```
public Optional<Integer> maxEntries()
```
    The maximum number of entries to return.
    
    Specified by:
    
    maxEntries in interface DirectoryListingParams
  - statFileEntries
```
public boolean statFileEntries()
```
    Whether to return stat info for file entries.
    
    Specified by:
    
    statFileEntries in interface DirectoryListingParams
  - browseIndexedData
```
public boolean browseIndexedData()
```
    Whether to use index data for listing.
    
    Specified by:
    
    browseIndexedData in interface DirectoryListingParams
  - withBackupRunUid
```
public final ImmutableDirectoryListingParams withBackupRunUid(BackupRunUid value)
```
    Copy the current immutable object by setting a value for the backupRunUid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for backupRunUid
    
    Returns:
    
    A modified copy of the this object
  - withVmUuid
```
public final ImmutableDirectoryListingParams withVmUuid(VmUuid value)
```
    Copy the current immutable object by setting a value for the vmUuid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for vmUuid
    
    Returns:
    
    A modified copy of the this object
  - withVolumeName
```
public final ImmutableDirectoryListingParams withVolumeName(String value)
```
    Copy the current immutable object by setting a value for the volumeName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for volumeName
    
    Returns:
    
    A modified copy of the this object
  - withDirectoryPath
```
public final ImmutableDirectoryListingParams withDirectoryPath(String value)
```
    Copy the current immutable object by setting a value for the directoryPath attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for directoryPath
    
    Returns:
    
    A modified copy of the this object
  - withAttemptNumber
```
public final ImmutableDirectoryListingParams withAttemptNumber(int value)
```
    Copy the current immutable object by setting a value for the attemptNumber attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for attemptNumber
    
    Returns:
    
    A modified copy of the this object
  - withPaginationCookie
```
public final ImmutableDirectoryListingParams withPaginationCookie(String value)
```
    Copy the current immutable object by setting a present value for the optional paginationCookie attribute.
    
    Parameters:
    
    value - The value for paginationCookie
    
    Returns:
    
    A modified copy of this object
  - withPaginationCookie
```
public final ImmutableDirectoryListingParams withPaginationCookie(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the paginationCookie attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for paginationCookie
    
    Returns:
    
    A modified copy of this object
  - withMaxEntries
```
public final ImmutableDirectoryListingParams withMaxEntries(int value)
```
    Copy the current immutable object by setting a present value for the optional maxEntries attribute.
    
    Parameters:
    
    value - The value for maxEntries
    
    Returns:
    
    A modified copy of this object
  - withMaxEntries
```
public final ImmutableDirectoryListingParams withMaxEntries(Optional<Integer> optional)
```
    Copy the current immutable object by setting an optional value for the maxEntries attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for maxEntries
    
    Returns:
    
    A modified copy of this object
  - withStatFileEntries
```
public final ImmutableDirectoryListingParams withStatFileEntries(boolean value)
```
    Copy the current immutable object by setting a value for the statFileEntries attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for statFileEntries
    
    Returns:
    
    A modified copy of the this object
  - withBrowseIndexedData
```
public final ImmutableDirectoryListingParams withBrowseIndexedData(boolean value)
```
    Copy the current immutable object by setting a value for the browseIndexedData attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for browseIndexedData
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableDirectoryListingParams that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: backupRunUid, vmUuid, volumeName, directoryPath, attemptNumber, paginationCookie, maxEntries, statFileEntries, browseIndexedData.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value DirectoryListingParams with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableDirectoryListingParams copyOf(DirectoryListingParams instance)
```
    Creates an immutable copy of a DirectoryListingParams value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable DirectoryListingParams instance
  - builder
```
public static ImmutableDirectoryListingParams.Builder builder()
```
    Creates a builder for ImmutableDirectoryListingParams.
```
 ImmutableDirectoryListingParams.builder()
    .backupRunUid(com.iland.cohesity.iaas.backups.common.model.BackupRunUid) // required backupRunUid
    .vmUuid(com.iland.cohesity.iaas.backups.common.model.VmUuid) // required vmUuid
    .volumeName(String) // required volumeName
    .directoryPath(String) // required directoryPath
    .attemptNumber(int) // optional attemptNumber
    .paginationCookie(String) // optional paginationCookie
    .maxEntries(Integer) // optional maxEntries
    .statFileEntries(boolean) // optional statFileEntries
    .browseIndexedData(boolean) // optional browseIndexedData
    .build();
 
```
    Returns:
    
    A new ImmutableDirectoryListingParams builder

Class ImmutableDirectoryListingParams

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

backupRunUid

vmUuid

volumeName

directoryPath

attemptNumber

paginationCookie

maxEntries

statFileEntries

browseIndexedData

withBackupRunUid

withVmUuid

withVolumeName

withDirectoryPath

withAttemptNumber

withPaginationCookie

withPaginationCookie

withMaxEntries

withMaxEntries

withStatFileEntries

withBrowseIndexedData

equals

hashCode

toString

copyOf

builder