ImmutableRecoverableFileSearchResult (iland cloud Java SDK 1.0.45 API)

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

All Implemented Interfaces:: RecoverableFileSearchResult

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

Immutable implementation of RecoverableFileSearchResult.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableRecoverableFileSearchResult.Builder
Builds instances of type ImmutableRecoverableFileSearchResult.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupGroupUid`	`backupGroupUid()` Specifies the UID of the backup group that is currently associated with the object that contains the backed up file or folder.
`static ImmutableRecoverableFileSearchResult.Builder`	`builder()` Creates a builder for `ImmutableRecoverableFileSearchResult`.
`CompanyId`	`companyId()` The ID of the company that the result is associated with.
`static ImmutableRecoverableFileSearchResult`	`copyOf(RecoverableFileSearchResult instance)` Creates an immutable copy of a `RecoverableFileSearchResult` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableRecoverableFileSearchResult` that have equal attribute values.
`String`	`filename()` Specifies the name of the found file or folder.
`int`	`hashCode()` Computes a hash code from attributes: `locationId`, `companyId`, `orgUuid`, `vdcUuid`, `vappUuid`, `vmUuid`, `filename`, `isFolder`, `backupGroupUid`, `type`, `vmName`.
`boolean`	`isFolder()` Specifies if the found item is a folder.
`LocationId`	`locationId()` The ID of the location that the result is associated with.
`OrgUuid`	`orgUuid()` The UUID of the Org that the result is associated with.
`String`	`toString()` Prints the immutable value `RecoverableFileSearchResult` with attribute values.
`FileSearchResultType`	`type()` Specifies the type of the file document such as DIRECTORY, FILE, etc.
`VappUuid`	`vappUuid()` The UUID of the vApp that the result is associated with.
`VdcUuid`	`vdcUuid()` The UUID of the vDC that the result is associated with.
`String`	`vmName()` The name of the associated VM.
`VmUuid`	`vmUuid()` The UUID of the VM that the result is associated with.
`ImmutableRecoverableFileSearchResult`	`withBackupGroupUid(BackupGroupUid value)` Copy the current immutable object by setting a value for the `backupGroupUid` attribute.
`ImmutableRecoverableFileSearchResult`	`withCompanyId(CompanyId value)` Copy the current immutable object by setting a value for the `companyId` attribute.
`ImmutableRecoverableFileSearchResult`	`withFilename(String value)` Copy the current immutable object by setting a value for the `filename` attribute.
`ImmutableRecoverableFileSearchResult`	`withIsFolder(boolean value)` Copy the current immutable object by setting a value for the `isFolder` attribute.
`ImmutableRecoverableFileSearchResult`	`withLocationId(LocationId value)` Copy the current immutable object by setting a value for the `locationId` attribute.
`ImmutableRecoverableFileSearchResult`	`withOrgUuid(OrgUuid value)` Copy the current immutable object by setting a value for the `orgUuid` attribute.
`ImmutableRecoverableFileSearchResult`	`withType(FileSearchResultType value)` Copy the current immutable object by setting a value for the `type` attribute.
`ImmutableRecoverableFileSearchResult`	`withVappUuid(VappUuid value)` Copy the current immutable object by setting a value for the `vappUuid` attribute.
`ImmutableRecoverableFileSearchResult`	`withVdcUuid(VdcUuid value)` Copy the current immutable object by setting a value for the `vdcUuid` attribute.
`ImmutableRecoverableFileSearchResult`	`withVmName(String value)` Copy the current immutable object by setting a value for the `vmName` attribute.
`ImmutableRecoverableFileSearchResult`	`withVmUuid(VmUuid value)` Copy the current immutable object by setting a value for the `vmUuid` attribute.

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

- Method Detail
  - locationId
```
public LocationId locationId()
```
    The ID of the location that the result is associated with.
    
    Specified by:
    
    locationId in interface RecoverableFileSearchResult
  - companyId
```
public CompanyId companyId()
```
    The ID of the company that the result is associated with.
    
    Specified by:
    
    companyId in interface RecoverableFileSearchResult
  - orgUuid
```
public OrgUuid orgUuid()
```
    The UUID of the Org that the result is associated with.
    
    Specified by:
    
    orgUuid in interface RecoverableFileSearchResult
  - vdcUuid
```
public VdcUuid vdcUuid()
```
    The UUID of the vDC that the result is associated with.
    
    Specified by:
    
    vdcUuid in interface RecoverableFileSearchResult
  - vappUuid
```
public VappUuid vappUuid()
```
    The UUID of the vApp that the result is associated with.
    
    Specified by:
    
    vappUuid in interface RecoverableFileSearchResult
  - vmUuid
```
public VmUuid vmUuid()
```
    The UUID of the VM that the result is associated with.
    
    Specified by:
    
    vmUuid in interface RecoverableFileSearchResult
  - filename
```
public String filename()
```
    Specifies the name of the found file or folder.
    
    Specified by:
    
    filename in interface RecoverableFileSearchResult
  - isFolder
```
public boolean isFolder()
```
    Specifies if the found item is a folder. If true, the found item is a folder.
    
    Specified by:
    
    isFolder in interface RecoverableFileSearchResult
  - backupGroupUid
```
public BackupGroupUid backupGroupUid()
```
    Specifies the UID of the backup group that is currently associated with the object that contains the backed up file or folder.
    
    Specified by:
    
    backupGroupUid in interface RecoverableFileSearchResult
  - type
```
public FileSearchResultType type()
```
    Specifies the type of the file document such as DIRECTORY, FILE, etc.
    
    Specified by:
    
    type in interface RecoverableFileSearchResult
  - vmName
```
public String vmName()
```
    The name of the associated VM.
    
    Specified by:
    
    vmName in interface RecoverableFileSearchResult
  - withLocationId
```
public final ImmutableRecoverableFileSearchResult withLocationId(LocationId value)
```
    Copy the current immutable object by setting a value for the locationId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for locationId
    
    Returns:
    
    A modified copy of the this object
  - withCompanyId
```
public final ImmutableRecoverableFileSearchResult withCompanyId(CompanyId value)
```
    Copy the current immutable object by setting a value for the companyId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for companyId
    
    Returns:
    
    A modified copy of the this object
  - withOrgUuid
```
public final ImmutableRecoverableFileSearchResult withOrgUuid(OrgUuid value)
```
    Copy the current immutable object by setting a value for the orgUuid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for orgUuid
    
    Returns:
    
    A modified copy of the this object
  - withVdcUuid
```
public final ImmutableRecoverableFileSearchResult withVdcUuid(VdcUuid value)
```
    Copy the current immutable object by setting a value for the vdcUuid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for vdcUuid
    
    Returns:
    
    A modified copy of the this object
  - withVappUuid
```
public final ImmutableRecoverableFileSearchResult withVappUuid(VappUuid value)
```
    Copy the current immutable object by setting a value for the vappUuid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for vappUuid
    
    Returns:
    
    A modified copy of the this object
  - withVmUuid
```
public final ImmutableRecoverableFileSearchResult 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
  - withFilename
```
public final ImmutableRecoverableFileSearchResult withFilename(String value)
```
    Copy the current immutable object by setting a value for the filename attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for filename
    
    Returns:
    
    A modified copy of the this object
  - withIsFolder
```
public final ImmutableRecoverableFileSearchResult withIsFolder(boolean value)
```
    Copy the current immutable object by setting a value for the isFolder attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isFolder
    
    Returns:
    
    A modified copy of the this object
  - withBackupGroupUid
```
public final ImmutableRecoverableFileSearchResult withBackupGroupUid(BackupGroupUid value)
```
    Copy the current immutable object by setting a value for the backupGroupUid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for backupGroupUid
    
    Returns:
    
    A modified copy of the this object
  - withType
```
public final ImmutableRecoverableFileSearchResult withType(FileSearchResultType value)
```
    Copy the current immutable object by setting a value for the type attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for type
    
    Returns:
    
    A modified copy of the this object
  - withVmName
```
public final ImmutableRecoverableFileSearchResult withVmName(String value)
```
    Copy the current immutable object by setting a value for the vmName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for vmName
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableRecoverableFileSearchResult 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: locationId, companyId, orgUuid, vdcUuid, vappUuid, vmUuid, filename, isFolder, backupGroupUid, type, vmName.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value RecoverableFileSearchResult with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableRecoverableFileSearchResult copyOf(RecoverableFileSearchResult instance)
```
    Creates an immutable copy of a RecoverableFileSearchResult 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 RecoverableFileSearchResult instance
  - builder
```
public static ImmutableRecoverableFileSearchResult.Builder builder()
```
    Creates a builder for ImmutableRecoverableFileSearchResult.
```
 ImmutableRecoverableFileSearchResult.builder()
    .locationId(com.iland.cohesity.iaas.backups.common.model.LocationId) // required locationId
    .companyId(com.iland.cohesity.iaas.backups.common.model.CompanyId) // required companyId
    .orgUuid(com.iland.cohesity.iaas.backups.common.model.OrgUuid) // required orgUuid
    .vdcUuid(com.iland.cohesity.iaas.backups.common.model.VdcUuid) // required vdcUuid
    .vappUuid(com.iland.cohesity.iaas.backups.common.model.VappUuid) // required vappUuid
    .vmUuid(com.iland.cohesity.iaas.backups.common.model.VmUuid) // required vmUuid
    .filename(String) // required filename
    .isFolder(boolean) // required isFolder
    .backupGroupUid(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid) // required backupGroupUid
    .type(com.iland.cohesity.iaas.backups.common.enums.FileSearchResultType) // required type
    .vmName(String) // required vmName
    .build();
 
```
    Returns:
    
    A new ImmutableRecoverableFileSearchResult builder

Class ImmutableRecoverableFileSearchResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

locationId

companyId

orgUuid

vdcUuid

vappUuid

vmUuid

filename

isFolder

backupGroupUid

type

vmName

withLocationId

withCompanyId

withOrgUuid

withVdcUuid

withVappUuid

withVmUuid

withFilename

withIsFolder

withBackupGroupUid

withType

withVmName

equals

hashCode

toString

copyOf

builder