AlterVideoRequest (Kinetica Java API 7.2.3.4 API)

java.lang.Object
- com.gpudb.protocol.AlterVideoRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class AlterVideoRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.alterVideo.
Alters a video.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AlterVideoRequest.Options
A set of string constants for the AlterVideoRequest parameter options.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AlterVideoRequest.Options` A set of string constants for the `AlterVideoRequest` parameter `options`.

Constructor Summary

Constructors
Constructor and Description
`AlterVideoRequest()` Constructs an AlterVideoRequest object with default parameters.
`AlterVideoRequest(String path, Map<String,String> options)` Constructs an AlterVideoRequest object with the specified parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`Map<String,String>`	`getOptions()` Optional parameters.
`String`	`getPath()` Fully-qualified	`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`AlterVideoRequest`	`setOptions(Map<String,String> options)` Optional parameters.
`AlterVideoRequest`	`setPath(String path)` Fully-qualified	`String`	`toString()`

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

- Constructor Detail
  - AlterVideoRequest
```
public AlterVideoRequest()
```
    Constructs an AlterVideoRequest object with default parameters.
  - AlterVideoRequest
```
public AlterVideoRequest(String path,
                         Map<String,String> options)
```
    Constructs an AlterVideoRequest object with the specified parameters.
    Parameters:
    
    path - Fully-qualified KiFS path to the video to be altered.
    options - Optional parameters.
    
    TTL: Sets the TTL of the video.
    The default value is an empty Map.
- Method Detail
  - getClassSchema
```
public static org.apache.avro.Schema getClassSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Returns:
    
    The schema for the class.
  - getPath
```
public String getPath()
```
    Fully-qualified KiFS path to the video to be altered.
    
    Returns:
    
    The current value of path.
  - setPath
```
public AlterVideoRequest setPath(String path)
```
    Fully-qualified KiFS path to the video to be altered.
    
    Parameters:
    
    path - The new value for path.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    Optional parameters.
    - TTL: Sets the TTL of the video.
    The default value is an empty Map.
    Returns:
    
    The current value of options.
  - setOptions
```
public AlterVideoRequest setOptions(Map<String,String> options)
```
    Optional parameters.
    - TTL: Sets the TTL of the video.
    The default value is an empty Map.
    Parameters:
    
    options - The new value for options.
    
    Returns:
    
    this to mimic the builder pattern.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Returns:
    
    The schema object describing this class.
  - get
```
public Object get(int index)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to get
    
    Returns:
    
    value of the field with the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - put
```
public void put(int index,
                Object value)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to set
    
    value - the value to set
    
    Throws:
    
    IndexOutOfBoundsException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AlterVideoRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlterVideoRequest

AlterVideoRequest

Method Detail

getClassSchema

getPath

setPath

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode