public static final class CreateReadSessionRequest.Builder extends GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder> implements CreateReadSessionRequestOrBuilder Request message for CreateReadSession.
Protobuf type google.cloud.bigquery.storage.v1.CreateReadSessionRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateReadSessionRequest.BuilderImplements
CreateReadSessionRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateReadSessionRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
build()
public CreateReadSessionRequest build()| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest | |
buildPartial()
public CreateReadSessionRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest | |
clear()
public CreateReadSessionRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public CreateReadSessionRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
clearMaxStreamCount()
public CreateReadSessionRequest.Builder clearMaxStreamCount()Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. There is a default system max limit of 1,000.
This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.
int32 max_stream_count = 3;
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateReadSessionRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
clearParent()
public CreateReadSessionRequest.Builder clearParent() Required. The request project that owns the session, in the form of
projects/{project_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | This builder for chaining. |
clearPreferredMinStreamCount()
public CreateReadSessionRequest.Builder clearPreferredMinStreamCount()The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization).
The system will make a best effort to provide at least this number of streams, but in some cases might provide less.
int32 preferred_min_stream_count = 4;
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | This builder for chaining. |
clearReadSession()
public CreateReadSessionRequest.Builder clearReadSession()Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
clone()
public CreateReadSessionRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
getDefaultInstanceForType()
public CreateReadSessionRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getMaxStreamCount()
public int getMaxStreamCount()Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. There is a default system max limit of 1,000.
This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.
int32 max_stream_count = 3;
| Returns | |
|---|---|
| Type | Description |
int | The maxStreamCount. |
getParent()
public String getParent() Required. The request project that owns the session, in the form of
projects/{project_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes() Required. The request project that owns the session, in the form of
projects/{project_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
getPreferredMinStreamCount()
public int getPreferredMinStreamCount()The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization).
The system will make a best effort to provide at least this number of streams, but in some cases might provide less.
int32 preferred_min_stream_count = 4;
| Returns | |
|---|---|
| Type | Description |
int | The preferredMinStreamCount. |
getReadSession()
public ReadSession getReadSession()Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ReadSession | The readSession. |
getReadSessionBuilder()
public ReadSession.Builder getReadSessionBuilder()Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ReadSession.Builder | |
getReadSessionOrBuilder()
public ReadSessionOrBuilder getReadSessionOrBuilder()Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ReadSessionOrBuilder | |
hasReadSession()
public boolean hasReadSession()Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the readSession field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CreateReadSessionRequest other)
public CreateReadSessionRequest.Builder mergeFrom(CreateReadSessionRequest other)| Parameter | |
|---|---|
| Name | Description |
other | CreateReadSessionRequest |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateReadSessionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public CreateReadSessionRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
mergeReadSession(ReadSession value)
public CreateReadSessionRequest.Builder mergeReadSession(ReadSession value)Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ReadSession |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateReadSessionRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public CreateReadSessionRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
setMaxStreamCount(int value)
public CreateReadSessionRequest.Builder setMaxStreamCount(int value)Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. There is a default system max limit of 1,000.
This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.
int32 max_stream_count = 3;
| Parameter | |
|---|---|
| Name | Description |
value | intThe maxStreamCount to set. |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | This builder for chaining. |
setParent(String value)
public CreateReadSessionRequest.Builder setParent(String value) Required. The request project that owns the session, in the form of
projects/{project_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public CreateReadSessionRequest.Builder setParentBytes(ByteString value) Required. The request project that owns the session, in the form of
projects/{project_id}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | This builder for chaining. |
setPreferredMinStreamCount(int value)
public CreateReadSessionRequest.Builder setPreferredMinStreamCount(int value)The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization).
The system will make a best effort to provide at least this number of streams, but in some cases might provide less.
int32 preferred_min_stream_count = 4;
| Parameter | |
|---|---|
| Name | Description |
value | intThe preferredMinStreamCount to set. |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | This builder for chaining. |
setReadSession(ReadSession value)
public CreateReadSessionRequest.Builder setReadSession(ReadSession value)Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ReadSession |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
setReadSession(ReadSession.Builder builderForValue)
public CreateReadSessionRequest.Builder setReadSession(ReadSession.Builder builderForValue)Required. Session to be created.
.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ReadSession.Builder |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreateReadSessionRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateReadSessionRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateReadSessionRequest.Builder | |