MysqlxCursor.Open.Builder (aws-mysql-jdbc 1.1.5 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
    - - com.mysql.cj.x.protobuf.MysqlxCursor.Open.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MysqlxCursor.OpenOrBuilder, java.lang.Cloneable

Enclosing class:: MysqlxCursor.Open

public static final class MysqlxCursor.Open.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
implements MysqlxCursor.OpenOrBuilder


Open a cursor
@startuml
client -> server: Open
alt Success
... none or partial Resultsets or full Resultsets ...
client <- server: StmtExecuteOk
else Failure
client <- server: Error
end alt
@enduml
@returns @ref Mysqlx::Ok

Protobuf type Mysqlx.Cursor.Open

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MysqlxCursor.Open.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`MysqlxCursor.Open`	`build()`
`MysqlxCursor.Open`	`buildPartial()`
`MysqlxCursor.Open.Builder`	`clear()`
`MysqlxCursor.Open.Builder`	`clearCursorId()` client-side assigned cursor ID; the ID is going to represent the new cursor and assigned to it the statement
`MysqlxCursor.Open.Builder`	`clearFetchRows()` number of rows that should be retrieved from sequential cursor
`MysqlxCursor.Open.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`MysqlxCursor.Open.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`MysqlxCursor.Open.Builder`	`clearStmt()` statement for which the resultset is going to be iterated through by the cursor
`MysqlxCursor.Open.Builder`	`clone()`
`int`	`getCursorId()` client-side assigned cursor ID; the ID is going to represent the new cursor and assigned to it the statement
`MysqlxCursor.Open`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`long`	`getFetchRows()` number of rows that should be retrieved from sequential cursor
`MysqlxCursor.Open.OneOfMessage`	`getStmt()` statement for which the resultset is going to be iterated through by the cursor
`MysqlxCursor.Open.OneOfMessage.Builder`	`getStmtBuilder()` statement for which the resultset is going to be iterated through by the cursor
`MysqlxCursor.Open.OneOfMessageOrBuilder`	`getStmtOrBuilder()` statement for which the resultset is going to be iterated through by the cursor
`boolean`	`hasCursorId()` client-side assigned cursor ID; the ID is going to represent the new cursor and assigned to it the statement
`boolean`	`hasFetchRows()` number of rows that should be retrieved from sequential cursor
`boolean`	`hasStmt()` statement for which the resultset is going to be iterated through by the cursor
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`MysqlxCursor.Open.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`MysqlxCursor.Open.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`MysqlxCursor.Open.Builder`	`mergeFrom(MysqlxCursor.Open other)`
`MysqlxCursor.Open.Builder`	`mergeStmt(MysqlxCursor.Open.OneOfMessage value)` statement for which the resultset is going to be iterated through by the cursor
`MysqlxCursor.Open.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`MysqlxCursor.Open.Builder`	`setCursorId(int value)` client-side assigned cursor ID; the ID is going to represent the new cursor and assigned to it the statement
`MysqlxCursor.Open.Builder`	`setFetchRows(long value)` number of rows that should be retrieved from sequential cursor
`MysqlxCursor.Open.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`MysqlxCursor.Open.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`MysqlxCursor.Open.Builder`	`setStmt(MysqlxCursor.Open.OneOfMessage.Builder builderForValue)` statement for which the resultset is going to be iterated through by the cursor
`MysqlxCursor.Open.Builder`	`setStmt(MysqlxCursor.Open.OneOfMessage value)` statement for which the resultset is going to be iterated through by the cursor
`MysqlxCursor.Open.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - clear
```
public MysqlxCursor.Open.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - getDefaultInstanceForType
```
public MysqlxCursor.Open getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public MysqlxCursor.Open build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public MysqlxCursor.Open buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public MysqlxCursor.Open.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - setField
```
public MysqlxCursor.Open.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          java.lang.Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - clearField
```
public MysqlxCursor.Open.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - clearOneof
```
public MysqlxCursor.Open.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - setRepeatedField
```
public MysqlxCursor.Open.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  java.lang.Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - addRepeatedField
```
public MysqlxCursor.Open.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  java.lang.Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - mergeFrom
```
public MysqlxCursor.Open.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MysqlxCursor.Open.Builder>
  - mergeFrom
```
public MysqlxCursor.Open.Builder mergeFrom(MysqlxCursor.Open other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - mergeFrom
```
public MysqlxCursor.Open.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MysqlxCursor.Open.Builder>
    
    Throws:
    
    java.io.IOException
  - hasCursorId
```
public boolean hasCursorId()
```
```
 client-side assigned cursor ID; the ID is going to represent
the new cursor and assigned to it the statement 
 
```
    required uint32 cursor_id = 1;
    Specified by:
    
    hasCursorId in interface MysqlxCursor.OpenOrBuilder
    
    Returns:
    
    Whether the cursorId field is set.
  - getCursorId
```
public int getCursorId()
```
```
 client-side assigned cursor ID; the ID is going to represent
the new cursor and assigned to it the statement 
 
```
    required uint32 cursor_id = 1;
    Specified by:
    
    getCursorId in interface MysqlxCursor.OpenOrBuilder
    
    Returns:
    
    The cursorId.
  - setCursorId
```
public MysqlxCursor.Open.Builder setCursorId(int value)
```
```
 client-side assigned cursor ID; the ID is going to represent
the new cursor and assigned to it the statement 
 
```
    required uint32 cursor_id = 1;
    Parameters:
    
    value - The cursorId to set.
    
    Returns:
    
    This builder for chaining.
  - clearCursorId
```
public MysqlxCursor.Open.Builder clearCursorId()
```
```
 client-side assigned cursor ID; the ID is going to represent
the new cursor and assigned to it the statement 
 
```
    required uint32 cursor_id = 1;
    Returns:
    
    This builder for chaining.
  - hasStmt
```
public boolean hasStmt()
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
    Specified by:
    
    hasStmt in interface MysqlxCursor.OpenOrBuilder
    
    Returns:
    
    Whether the stmt field is set.
  - getStmt
```
public MysqlxCursor.Open.OneOfMessage getStmt()
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
    Specified by:
    
    getStmt in interface MysqlxCursor.OpenOrBuilder
    
    Returns:
    
    The stmt.
  - setStmt
```
public MysqlxCursor.Open.Builder setStmt(MysqlxCursor.Open.OneOfMessage value)
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
  - setStmt
```
public MysqlxCursor.Open.Builder setStmt(MysqlxCursor.Open.OneOfMessage.Builder builderForValue)
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
  - mergeStmt
```
public MysqlxCursor.Open.Builder mergeStmt(MysqlxCursor.Open.OneOfMessage value)
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
  - clearStmt
```
public MysqlxCursor.Open.Builder clearStmt()
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
  - getStmtBuilder
```
public MysqlxCursor.Open.OneOfMessage.Builder getStmtBuilder()
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
  - getStmtOrBuilder
```
public MysqlxCursor.Open.OneOfMessageOrBuilder getStmtOrBuilder()
```
```
 statement for which the resultset is going to be iterated through by the cursor 
 
```
    required .Mysqlx.Cursor.Open.OneOfMessage stmt = 4;
    Specified by:
    
    getStmtOrBuilder in interface MysqlxCursor.OpenOrBuilder
  - hasFetchRows
```
public boolean hasFetchRows()
```
```
 number of rows that should be retrieved from sequential cursor 
 
```
    optional uint64 fetch_rows = 5;
    Specified by:
    
    hasFetchRows in interface MysqlxCursor.OpenOrBuilder
    
    Returns:
    
    Whether the fetchRows field is set.
  - getFetchRows
```
public long getFetchRows()
```
```
 number of rows that should be retrieved from sequential cursor 
 
```
    optional uint64 fetch_rows = 5;
    Specified by:
    
    getFetchRows in interface MysqlxCursor.OpenOrBuilder
    
    Returns:
    
    The fetchRows.
  - setFetchRows
```
public MysqlxCursor.Open.Builder setFetchRows(long value)
```
```
 number of rows that should be retrieved from sequential cursor 
 
```
    optional uint64 fetch_rows = 5;
    Parameters:
    
    value - The fetchRows to set.
    
    Returns:
    
    This builder for chaining.
  - clearFetchRows
```
public MysqlxCursor.Open.Builder clearFetchRows()
```
```
 number of rows that should be retrieved from sequential cursor 
 
```
    optional uint64 fetch_rows = 5;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final MysqlxCursor.Open.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>
  - mergeUnknownFields
```
public final MysqlxCursor.Open.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MysqlxCursor.Open.Builder>

Class MysqlxCursor.Open.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasCursorId

getCursorId

setCursorId

clearCursorId

hasStmt

getStmt

setStmt

setStmt

mergeStmt

clearStmt

getStmtBuilder

getStmtOrBuilder

hasFetchRows

getFetchRows

setFetchRows

clearFetchRows

setUnknownFields

mergeUnknownFields