bytestream

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2024 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ByteStream_Read_FullMethodName             = "/google.bytestream.ByteStream/Read"
	ByteStream_Write_FullMethodName            = "/google.bytestream.ByteStream/Write"
	ByteStream_QueryWriteStatus_FullMethodName = "/google.bytestream.ByteStream/QueryWriteStatus"
)

Variables

View Source 
var ByteStream_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.bytestream.ByteStream",
	HandlerType: (*ByteStreamServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "QueryWriteStatus",
			Handler:    _ByteStream_QueryWriteStatus_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Read",
			Handler:       _ByteStream_Read_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "Write",
			Handler:       _ByteStream_Write_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "google/bytestream/bytestream.proto",
}

ByteStream_ServiceDesc is the grpc.ServiceDesc for ByteStream service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_google_bytestream_bytestream_proto protoreflect.FileDescriptor

Functions

func RegisterByteStreamServer 

func RegisterByteStreamServer(s grpc.ServiceRegistrar, srv ByteStreamServer)

Types

type ByteStreamClient 

type ByteStreamClient interface {
	// `Read()` is used to retrieve the contents of a resource as a sequence
	// of bytes. The bytes are returned in a sequence of responses, and the
	// responses are delivered as the results of a server-side streaming RPC.
	Read(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (ByteStream_ReadClient, error)
	// `Write()` is used to send the contents of a resource as a sequence of
	// bytes. The bytes are sent in a sequence of request protos of a client-side
	// streaming RPC.
	//
	// A `Write()` action is resumable. If there is an error or the connection is
	// broken during the `Write()`, the client should check the status of the
	// `Write()` by calling `QueryWriteStatus()` and continue writing from the
	// returned `committed_size`. This may be less than the amount of data the
	// client previously sent.
	//
	// Calling `Write()` on a resource name that was previously written and
	// finalized could cause an error, depending on whether the underlying service
	// allows over-writing of previously written resources.
	//
	// When the client closes the request channel, the service will respond with
	// a `WriteResponse`. The service will not view the resource as `complete`
	// until the client has sent a `WriteRequest` with `finish_write` set to
	// `true`. Sending any requests on a stream after sending a request with
	// `finish_write` set to `true` will cause an error. The client **should**
	// check the `WriteResponse` it receives to determine how much data the
	// service was able to commit and whether the service views the resource as
	// `complete` or not.
	Write(ctx context.Context, opts ...grpc.CallOption) (ByteStream_WriteClient, error)
	// `QueryWriteStatus()` is used to find the `committed_size` for a resource
	// that is being written, which can then be used as the `write_offset` for
	// the next `Write()` call.
	//
	// If the resource does not exist (i.e., the resource has been deleted, or the
	// first `Write()` has not yet reached the service), this method returns the
	// error `NOT_FOUND`.
	//
	// The client **may** call `QueryWriteStatus()` at any time to determine how
	// much data has been processed for this resource. This is useful if the
	// client is buffering data and needs to know which data can be safely
	// evicted. For any sequence of `QueryWriteStatus()` calls for a given
	// resource name, the sequence of returned `committed_size` values will be
	// non-decreasing.
	QueryWriteStatus(ctx context.Context, in *QueryWriteStatusRequest, opts ...grpc.CallOption) (*QueryWriteStatusResponse, error)
}

ByteStreamClient is the client API for ByteStream service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewByteStreamClient 

func NewByteStreamClient(cc grpc.ClientConnInterface) ByteStreamClient

type ByteStreamServer 

type ByteStreamServer interface {
	// `Read()` is used to retrieve the contents of a resource as a sequence
	// of bytes. The bytes are returned in a sequence of responses, and the
	// responses are delivered as the results of a server-side streaming RPC.
	Read(*ReadRequest, ByteStream_ReadServer) error
	// `Write()` is used to send the contents of a resource as a sequence of
	// bytes. The bytes are sent in a sequence of request protos of a client-side
	// streaming RPC.
	//
	// A `Write()` action is resumable. If there is an error or the connection is
	// broken during the `Write()`, the client should check the status of the
	// `Write()` by calling `QueryWriteStatus()` and continue writing from the
	// returned `committed_size`. This may be less than the amount of data the
	// client previously sent.
	//
	// Calling `Write()` on a resource name that was previously written and
	// finalized could cause an error, depending on whether the underlying service
	// allows over-writing of previously written resources.
	//
	// When the client closes the request channel, the service will respond with
	// a `WriteResponse`. The service will not view the resource as `complete`
	// until the client has sent a `WriteRequest` with `finish_write` set to
	// `true`. Sending any requests on a stream after sending a request with
	// `finish_write` set to `true` will cause an error. The client **should**
	// check the `WriteResponse` it receives to determine how much data the
	// service was able to commit and whether the service views the resource as
	// `complete` or not.
	Write(ByteStream_WriteServer) error
	// `QueryWriteStatus()` is used to find the `committed_size` for a resource
	// that is being written, which can then be used as the `write_offset` for
	// the next `Write()` call.
	//
	// If the resource does not exist (i.e., the resource has been deleted, or the
	// first `Write()` has not yet reached the service), this method returns the
	// error `NOT_FOUND`.
	//
	// The client **may** call `QueryWriteStatus()` at any time to determine how
	// much data has been processed for this resource. This is useful if the
	// client is buffering data and needs to know which data can be safely
	// evicted. For any sequence of `QueryWriteStatus()` calls for a given
	// resource name, the sequence of returned `committed_size` values will be
	// non-decreasing.
	QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)
	// contains filtered or unexported methods
}

ByteStreamServer is the server API for ByteStream service. All implementations must embed UnimplementedByteStreamServer for forward compatibility

type ByteStream_ReadClient 

type ByteStream_ReadClient interface {
	Recv() (*ReadResponse, error)
	grpc.ClientStream
}

type ByteStream_ReadServer 

type ByteStream_ReadServer interface {
	Send(*ReadResponse) error
	grpc.ServerStream
}

type ByteStream_WriteClient 

type ByteStream_WriteClient interface {
	Send(*WriteRequest) error
	CloseAndRecv() (*WriteResponse, error)
	grpc.ClientStream
}

type ByteStream_WriteServer 

type ByteStream_WriteServer interface {
	SendAndClose(*WriteResponse) error
	Recv() (*WriteRequest, error)
	grpc.ServerStream
}

type QueryWriteStatusRequest 

type QueryWriteStatusRequest struct {

	// The name of the resource whose write status is being requested.
	ResourceName string `protobuf:"bytes,1,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
	// contains filtered or unexported fields
}

Request object for ByteStream.QueryWriteStatus.

func (*QueryWriteStatusRequest) CloneMessageVT 

func (m *QueryWriteStatusRequest) CloneMessageVT() proto.Message

func (*QueryWriteStatusRequest) CloneVT 

func (m *QueryWriteStatusRequest) CloneVT() *QueryWriteStatusRequest

func (*QueryWriteStatusRequest) Descriptor deprecated 

func (*QueryWriteStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryWriteStatusRequest.ProtoReflect.Descriptor instead.

func (*QueryWriteStatusRequest) EqualMessageVT 

func (this *QueryWriteStatusRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*QueryWriteStatusRequest) EqualVT 

func (this *QueryWriteStatusRequest) EqualVT(that *QueryWriteStatusRequest) bool

func (*QueryWriteStatusRequest) GetResourceName 

func (x *QueryWriteStatusRequest) GetResourceName() string

func (*QueryWriteStatusRequest) MarshalToSizedBufferVT 

func (m *QueryWriteStatusRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*QueryWriteStatusRequest) MarshalToVT 

func (m *QueryWriteStatusRequest) MarshalToVT(dAtA []byte) (int, error)

func (*QueryWriteStatusRequest) MarshalVT 

func (m *QueryWriteStatusRequest) MarshalVT() (dAtA []byte, err error)

func (*QueryWriteStatusRequest) ProtoMessage 

func (*QueryWriteStatusRequest) ProtoMessage()

func (*QueryWriteStatusRequest) ProtoReflect 

func (x *QueryWriteStatusRequest) ProtoReflect() protoreflect.Message

func (*QueryWriteStatusRequest) Reset 

func (x *QueryWriteStatusRequest) Reset()

func (*QueryWriteStatusRequest) SizeVT 

func (m *QueryWriteStatusRequest) SizeVT() (n int)

func (*QueryWriteStatusRequest) String 

func (x *QueryWriteStatusRequest) String() string

func (*QueryWriteStatusRequest) UnmarshalVT 

func (m *QueryWriteStatusRequest) UnmarshalVT(dAtA []byte) error

func (*QueryWriteStatusRequest) Validate 

func (m *QueryWriteStatusRequest) Validate() error

Validate checks the field values on QueryWriteStatusRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QueryWriteStatusRequest) ValidateAll 

func (m *QueryWriteStatusRequest) ValidateAll() error

ValidateAll checks the field values on QueryWriteStatusRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueryWriteStatusRequestMultiError, or nil if none found.

type QueryWriteStatusRequestMultiError 

type QueryWriteStatusRequestMultiError []error

QueryWriteStatusRequestMultiError is an error wrapping multiple validation errors returned by QueryWriteStatusRequest.ValidateAll() if the designated constraints aren't met.

func (QueryWriteStatusRequestMultiError) AllErrors 

func (m QueryWriteStatusRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueryWriteStatusRequestMultiError) Error 

func (m QueryWriteStatusRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QueryWriteStatusRequestValidationError 

type QueryWriteStatusRequestValidationError struct {
	// contains filtered or unexported fields
}

QueryWriteStatusRequestValidationError is the validation error returned by QueryWriteStatusRequest.Validate if the designated constraints aren't met.

func (QueryWriteStatusRequestValidationError) Cause 

func (e QueryWriteStatusRequestValidationError) Cause() error

Cause function returns cause value.

func (QueryWriteStatusRequestValidationError) Error 

func (e QueryWriteStatusRequestValidationError) Error() string

Error satisfies the builtin error interface

func (QueryWriteStatusRequestValidationError) ErrorName 

func (e QueryWriteStatusRequestValidationError) ErrorName() string

ErrorName returns error name.

func (QueryWriteStatusRequestValidationError) Field 

func (e QueryWriteStatusRequestValidationError) Field() string

Field function returns field value.

func (QueryWriteStatusRequestValidationError) Key 

func (e QueryWriteStatusRequestValidationError) Key() bool

Key function returns key value.

func (QueryWriteStatusRequestValidationError) Reason 

func (e QueryWriteStatusRequestValidationError) Reason() string

Reason function returns reason value.

type QueryWriteStatusResponse 

type QueryWriteStatusResponse struct {

	// The number of bytes that have been processed for the given resource.
	CommittedSize int64 `protobuf:"varint,1,opt,name=committed_size,json=committedSize,proto3" json:"committed_size,omitempty"`
	// `complete` is `true` only if the client has sent a `WriteRequest` with
	// `finish_write` set to true, and the server has processed that request.
	Complete bool `protobuf:"varint,2,opt,name=complete,proto3" json:"complete,omitempty"`
	// contains filtered or unexported fields
}

Response object for ByteStream.QueryWriteStatus.

func (*QueryWriteStatusResponse) CloneMessageVT 

func (m *QueryWriteStatusResponse) CloneMessageVT() proto.Message

func (*QueryWriteStatusResponse) CloneVT 

func (m *QueryWriteStatusResponse) CloneVT() *QueryWriteStatusResponse

func (*QueryWriteStatusResponse) Descriptor deprecated 

func (*QueryWriteStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryWriteStatusResponse.ProtoReflect.Descriptor instead.

func (*QueryWriteStatusResponse) EqualMessageVT 

func (this *QueryWriteStatusResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*QueryWriteStatusResponse) EqualVT 

func (this *QueryWriteStatusResponse) EqualVT(that *QueryWriteStatusResponse) bool

func (*QueryWriteStatusResponse) GetCommittedSize 

func (x *QueryWriteStatusResponse) GetCommittedSize() int64

func (*QueryWriteStatusResponse) GetComplete 

func (x *QueryWriteStatusResponse) GetComplete() bool

func (*QueryWriteStatusResponse) MarshalToSizedBufferVT 

func (m *QueryWriteStatusResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*QueryWriteStatusResponse) MarshalToVT 

func (m *QueryWriteStatusResponse) MarshalToVT(dAtA []byte) (int, error)

func (*QueryWriteStatusResponse) MarshalVT 

func (m *QueryWriteStatusResponse) MarshalVT() (dAtA []byte, err error)

func (*QueryWriteStatusResponse) ProtoMessage 

func (*QueryWriteStatusResponse) ProtoMessage()

func (*QueryWriteStatusResponse) ProtoReflect 

func (x *QueryWriteStatusResponse) ProtoReflect() protoreflect.Message

func (*QueryWriteStatusResponse) Reset 

func (x *QueryWriteStatusResponse) Reset()

func (*QueryWriteStatusResponse) SizeVT 

func (m *QueryWriteStatusResponse) SizeVT() (n int)

func (*QueryWriteStatusResponse) String 

func (x *QueryWriteStatusResponse) String() string

func (*QueryWriteStatusResponse) UnmarshalVT 

func (m *QueryWriteStatusResponse) UnmarshalVT(dAtA []byte) error

func (*QueryWriteStatusResponse) Validate 

func (m *QueryWriteStatusResponse) Validate() error

Validate checks the field values on QueryWriteStatusResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QueryWriteStatusResponse) ValidateAll 

func (m *QueryWriteStatusResponse) ValidateAll() error

ValidateAll checks the field values on QueryWriteStatusResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueryWriteStatusResponseMultiError, or nil if none found.

type QueryWriteStatusResponseMultiError 

type QueryWriteStatusResponseMultiError []error

QueryWriteStatusResponseMultiError is an error wrapping multiple validation errors returned by QueryWriteStatusResponse.ValidateAll() if the designated constraints aren't met.

func (QueryWriteStatusResponseMultiError) AllErrors 

func (m QueryWriteStatusResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueryWriteStatusResponseMultiError) Error 

func (m QueryWriteStatusResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QueryWriteStatusResponseValidationError 

type QueryWriteStatusResponseValidationError struct {
	// contains filtered or unexported fields
}

QueryWriteStatusResponseValidationError is the validation error returned by QueryWriteStatusResponse.Validate if the designated constraints aren't met.

func (QueryWriteStatusResponseValidationError) Cause 

func (e QueryWriteStatusResponseValidationError) Cause() error

Cause function returns cause value.

func (QueryWriteStatusResponseValidationError) Error 

func (e QueryWriteStatusResponseValidationError) Error() string

Error satisfies the builtin error interface

func (QueryWriteStatusResponseValidationError) ErrorName 

func (e QueryWriteStatusResponseValidationError) ErrorName() string

ErrorName returns error name.

func (QueryWriteStatusResponseValidationError) Field 

func (e QueryWriteStatusResponseValidationError) Field() string

Field function returns field value.

func (QueryWriteStatusResponseValidationError) Key 

func (e QueryWriteStatusResponseValidationError) Key() bool

Key function returns key value.

func (QueryWriteStatusResponseValidationError) Reason 

func (e QueryWriteStatusResponseValidationError) Reason() string

Reason function returns reason value.

type ReadRequest 

type ReadRequest struct {

	// The name of the resource to read.
	ResourceName string `protobuf:"bytes,1,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
	// The offset for the first byte to return in the read, relative to the start
	// of the resource.
	//
	// A `read_offset` that is negative or greater than the size of the resource
	// will cause an `OUT_OF_RANGE` error.
	ReadOffset int64 `protobuf:"varint,2,opt,name=read_offset,json=readOffset,proto3" json:"read_offset,omitempty"`
	// The maximum number of `data` bytes the server is allowed to return in the
	// sum of all `ReadResponse` messages. A `read_limit` of zero indicates that
	// there is no limit, and a negative `read_limit` will cause an error.
	//
	// If the stream returns fewer bytes than allowed by the `read_limit` and no
	// error occurred, the stream includes all data from the `read_offset` to the
	// end of the resource.
	ReadLimit int64 `protobuf:"varint,3,opt,name=read_limit,json=readLimit,proto3" json:"read_limit,omitempty"`
	// contains filtered or unexported fields
}

Request object for ByteStream.Read.

func (*ReadRequest) CloneMessageVT 

func (m *ReadRequest) CloneMessageVT() proto.Message

func (*ReadRequest) CloneVT 

func (m *ReadRequest) CloneVT() *ReadRequest

func (*ReadRequest) Descriptor deprecated 

func (*ReadRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.

func (*ReadRequest) EqualMessageVT 

func (this *ReadRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*ReadRequest) EqualVT 

func (this *ReadRequest) EqualVT(that *ReadRequest) bool

func (*ReadRequest) GetReadLimit 

func (x *ReadRequest) GetReadLimit() int64

func (*ReadRequest) GetReadOffset 

func (x *ReadRequest) GetReadOffset() int64

func (*ReadRequest) GetResourceName 

func (x *ReadRequest) GetResourceName() string

func (*ReadRequest) MarshalToSizedBufferVT 

func (m *ReadRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ReadRequest) MarshalToVT 

func (m *ReadRequest) MarshalToVT(dAtA []byte) (int, error)

func (*ReadRequest) MarshalVT 

func (m *ReadRequest) MarshalVT() (dAtA []byte, err error)

func (*ReadRequest) ProtoMessage 

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) ProtoReflect 

func (x *ReadRequest) ProtoReflect() protoreflect.Message

func (*ReadRequest) Reset 

func (x *ReadRequest) Reset()

func (*ReadRequest) SizeVT 

func (m *ReadRequest) SizeVT() (n int)

func (*ReadRequest) String 

func (x *ReadRequest) String() string

func (*ReadRequest) UnmarshalVT 

func (m *ReadRequest) UnmarshalVT(dAtA []byte) error

func (*ReadRequest) Validate 

func (m *ReadRequest) Validate() error

Validate checks the field values on ReadRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ReadRequest) ValidateAll 

func (m *ReadRequest) ValidateAll() error

ValidateAll checks the field values on ReadRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ReadRequestMultiError, or nil if none found.

type ReadRequestMultiError 

type ReadRequestMultiError []error

ReadRequestMultiError is an error wrapping multiple validation errors returned by ReadRequest.ValidateAll() if the designated constraints aren't met.

func (ReadRequestMultiError) AllErrors 

func (m ReadRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ReadRequestMultiError) Error 

func (m ReadRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ReadRequestValidationError 

type ReadRequestValidationError struct {
	// contains filtered or unexported fields
}

ReadRequestValidationError is the validation error returned by ReadRequest.Validate if the designated constraints aren't met.

func (ReadRequestValidationError) Cause 

func (e ReadRequestValidationError) Cause() error

Cause function returns cause value.

func (ReadRequestValidationError) Error 

func (e ReadRequestValidationError) Error() string

Error satisfies the builtin error interface

func (ReadRequestValidationError) ErrorName 

func (e ReadRequestValidationError) ErrorName() string

ErrorName returns error name.

func (ReadRequestValidationError) Field 

func (e ReadRequestValidationError) Field() string

Field function returns field value.

func (ReadRequestValidationError) Key 

func (e ReadRequestValidationError) Key() bool

Key function returns key value.

func (ReadRequestValidationError) Reason 

func (e ReadRequestValidationError) Reason() string

Reason function returns reason value.

type ReadResponse 

type ReadResponse struct {

	// A portion of the data for the resource. The service **may** leave `data`
	// empty for any given `ReadResponse`. This enables the service to inform the
	// client that the request is still live while it is running an operation to
	// generate more data.
	Data []byte `protobuf:"bytes,10,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Response object for ByteStream.Read.

func (*ReadResponse) CloneMessageVT 

func (m *ReadResponse) CloneMessageVT() proto.Message

func (*ReadResponse) CloneVT 

func (m *ReadResponse) CloneVT() *ReadResponse

func (*ReadResponse) Descriptor deprecated 

func (*ReadResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadResponse.ProtoReflect.Descriptor instead.

func (*ReadResponse) EqualMessageVT 

func (this *ReadResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*ReadResponse) EqualVT 

func (this *ReadResponse) EqualVT(that *ReadResponse) bool

func (*ReadResponse) GetData 

func (x *ReadResponse) GetData() []byte

func (*ReadResponse) MarshalToSizedBufferVT 

func (m *ReadResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ReadResponse) MarshalToVT 

func (m *ReadResponse) MarshalToVT(dAtA []byte) (int, error)

func (*ReadResponse) MarshalVT 

func (m *ReadResponse) MarshalVT() (dAtA []byte, err error)

func (*ReadResponse) ProtoMessage 

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) ProtoReflect 

func (x *ReadResponse) ProtoReflect() protoreflect.Message

func (*ReadResponse) Reset 

func (x *ReadResponse) Reset()

func (*ReadResponse) SizeVT 

func (m *ReadResponse) SizeVT() (n int)

func (*ReadResponse) String 

func (x *ReadResponse) String() string

func (*ReadResponse) UnmarshalVT 

func (m *ReadResponse) UnmarshalVT(dAtA []byte) error

func (*ReadResponse) Validate 

func (m *ReadResponse) Validate() error

Validate checks the field values on ReadResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ReadResponse) ValidateAll 

func (m *ReadResponse) ValidateAll() error

ValidateAll checks the field values on ReadResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ReadResponseMultiError, or nil if none found.

type ReadResponseMultiError 

type ReadResponseMultiError []error

ReadResponseMultiError is an error wrapping multiple validation errors returned by ReadResponse.ValidateAll() if the designated constraints aren't met.

func (ReadResponseMultiError) AllErrors 

func (m ReadResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ReadResponseMultiError) Error 

func (m ReadResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ReadResponseValidationError 

type ReadResponseValidationError struct {
	// contains filtered or unexported fields
}

ReadResponseValidationError is the validation error returned by ReadResponse.Validate if the designated constraints aren't met.

func (ReadResponseValidationError) Cause 

func (e ReadResponseValidationError) Cause() error

Cause function returns cause value.

func (ReadResponseValidationError) Error 

func (e ReadResponseValidationError) Error() string

Error satisfies the builtin error interface

func (ReadResponseValidationError) ErrorName 

func (e ReadResponseValidationError) ErrorName() string

ErrorName returns error name.

func (ReadResponseValidationError) Field 

func (e ReadResponseValidationError) Field() string

Field function returns field value.

func (ReadResponseValidationError) Key 

func (e ReadResponseValidationError) Key() bool

Key function returns key value.

func (ReadResponseValidationError) Reason 

func (e ReadResponseValidationError) Reason() string

Reason function returns reason value.

type UnimplementedByteStreamServer 

type UnimplementedByteStreamServer struct {
}

UnimplementedByteStreamServer must be embedded to have forward compatible implementations.

func (UnimplementedByteStreamServer) QueryWriteStatus 

func (UnimplementedByteStreamServer) QueryWriteStatus(context.Context, *QueryWriteStatusRequest) (*QueryWriteStatusResponse, error)

func (UnimplementedByteStreamServer) Read 

func (UnimplementedByteStreamServer) Read(*ReadRequest, ByteStream_ReadServer) error

func (UnimplementedByteStreamServer) Write 

func (UnimplementedByteStreamServer) Write(ByteStream_WriteServer) error

type UnsafeByteStreamServer 

type UnsafeByteStreamServer interface {
	// contains filtered or unexported methods
}

UnsafeByteStreamServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ByteStreamServer will result in compilation errors.

type WriteRequest 

type WriteRequest struct {

	// The name of the resource to write. This **must** be set on the first
	// `WriteRequest` of each `Write()` action. If it is set on subsequent calls,
	// it **must** match the value of the first request.
	ResourceName string `protobuf:"bytes,1,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
	// The offset from the beginning of the resource at which the data should be
	// written. It is required on all `WriteRequest`s.
	//
	// In the first `WriteRequest` of a `Write()` action, it indicates
	// the initial offset for the `Write()` call. The value **must** be equal to
	// the `committed_size` that a call to `QueryWriteStatus()` would return.
	//
	// On subsequent calls, this value **must** be set and **must** be equal to
	// the sum of the first `write_offset` and the sizes of all `data` bundles
	// sent previously on this stream.
	//
	// An incorrect value will cause an error.
	WriteOffset int64 `protobuf:"varint,2,opt,name=write_offset,json=writeOffset,proto3" json:"write_offset,omitempty"`
	// If `true`, this indicates that the write is complete. Sending any
	// `WriteRequest`s subsequent to one in which `finish_write` is `true` will
	// cause an error.
	FinishWrite bool `protobuf:"varint,3,opt,name=finish_write,json=finishWrite,proto3" json:"finish_write,omitempty"`
	// A portion of the data for the resource. The client **may** leave `data`
	// empty for any given `WriteRequest`. This enables the client to inform the
	// service that the request is still live while it is running an operation to
	// generate more data.
	Data []byte `protobuf:"bytes,10,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Request object for ByteStream.Write.

func (*WriteRequest) CloneMessageVT 

func (m *WriteRequest) CloneMessageVT() proto.Message

func (*WriteRequest) CloneVT 

func (m *WriteRequest) CloneVT() *WriteRequest

func (*WriteRequest) Descriptor deprecated 

func (*WriteRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.

func (*WriteRequest) EqualMessageVT 

func (this *WriteRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*WriteRequest) EqualVT 

func (this *WriteRequest) EqualVT(that *WriteRequest) bool

func (*WriteRequest) GetData 

func (x *WriteRequest) GetData() []byte

func (*WriteRequest) GetFinishWrite 

func (x *WriteRequest) GetFinishWrite() bool

func (*WriteRequest) GetResourceName 

func (x *WriteRequest) GetResourceName() string

func (*WriteRequest) GetWriteOffset 

func (x *WriteRequest) GetWriteOffset() int64

func (*WriteRequest) MarshalToSizedBufferVT 

func (m *WriteRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WriteRequest) MarshalToVT 

func (m *WriteRequest) MarshalToVT(dAtA []byte) (int, error)

func (*WriteRequest) MarshalVT 

func (m *WriteRequest) MarshalVT() (dAtA []byte, err error)

func (*WriteRequest) ProtoMessage 

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) ProtoReflect 

func (x *WriteRequest) ProtoReflect() protoreflect.Message

func (*WriteRequest) Reset 

func (x *WriteRequest) Reset()

func (*WriteRequest) SizeVT 

func (m *WriteRequest) SizeVT() (n int)

func (*WriteRequest) String 

func (x *WriteRequest) String() string

func (*WriteRequest) UnmarshalVT 

func (m *WriteRequest) UnmarshalVT(dAtA []byte) error

func (*WriteRequest) Validate 

func (m *WriteRequest) Validate() error

Validate checks the field values on WriteRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WriteRequest) ValidateAll 

func (m *WriteRequest) ValidateAll() error

ValidateAll checks the field values on WriteRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WriteRequestMultiError, or nil if none found.

type WriteRequestMultiError 

type WriteRequestMultiError []error

WriteRequestMultiError is an error wrapping multiple validation errors returned by WriteRequest.ValidateAll() if the designated constraints aren't met.

func (WriteRequestMultiError) AllErrors 

func (m WriteRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (WriteRequestMultiError) Error 

func (m WriteRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type WriteRequestValidationError 

type WriteRequestValidationError struct {
	// contains filtered or unexported fields
}

WriteRequestValidationError is the validation error returned by WriteRequest.Validate if the designated constraints aren't met.

func (WriteRequestValidationError) Cause 

func (e WriteRequestValidationError) Cause() error

Cause function returns cause value.

func (WriteRequestValidationError) Error 

func (e WriteRequestValidationError) Error() string

Error satisfies the builtin error interface

func (WriteRequestValidationError) ErrorName 

func (e WriteRequestValidationError) ErrorName() string

ErrorName returns error name.

func (WriteRequestValidationError) Field 

func (e WriteRequestValidationError) Field() string

Field function returns field value.

func (WriteRequestValidationError) Key 

func (e WriteRequestValidationError) Key() bool

Key function returns key value.

func (WriteRequestValidationError) Reason 

func (e WriteRequestValidationError) Reason() string

Reason function returns reason value.

type WriteResponse 

type WriteResponse struct {

	// The number of bytes that have been processed for the given resource.
	CommittedSize int64 `protobuf:"varint,1,opt,name=committed_size,json=committedSize,proto3" json:"committed_size,omitempty"`
	// contains filtered or unexported fields
}

Response object for ByteStream.Write.

func (*WriteResponse) CloneMessageVT 

func (m *WriteResponse) CloneMessageVT() proto.Message

func (*WriteResponse) CloneVT 

func (m *WriteResponse) CloneVT() *WriteResponse

func (*WriteResponse) Descriptor deprecated 

func (*WriteResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteResponse.ProtoReflect.Descriptor instead.

func (*WriteResponse) EqualMessageVT 

func (this *WriteResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*WriteResponse) EqualVT 

func (this *WriteResponse) EqualVT(that *WriteResponse) bool

func (*WriteResponse) GetCommittedSize 

func (x *WriteResponse) GetCommittedSize() int64

func (*WriteResponse) MarshalToSizedBufferVT 

func (m *WriteResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*WriteResponse) MarshalToVT 

func (m *WriteResponse) MarshalToVT(dAtA []byte) (int, error)

func (*WriteResponse) MarshalVT 

func (m *WriteResponse) MarshalVT() (dAtA []byte, err error)

func (*WriteResponse) ProtoMessage 

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) ProtoReflect 

func (x *WriteResponse) ProtoReflect() protoreflect.Message

func (*WriteResponse) Reset 

func (x *WriteResponse) Reset()

func (*WriteResponse) SizeVT 

func (m *WriteResponse) SizeVT() (n int)

func (*WriteResponse) String 

func (x *WriteResponse) String() string

func (*WriteResponse) UnmarshalVT 

func (m *WriteResponse) UnmarshalVT(dAtA []byte) error

func (*WriteResponse) Validate 

func (m *WriteResponse) Validate() error

Validate checks the field values on WriteResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WriteResponse) ValidateAll 

func (m *WriteResponse) ValidateAll() error

ValidateAll checks the field values on WriteResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WriteResponseMultiError, or nil if none found.

type WriteResponseMultiError 

type WriteResponseMultiError []error

WriteResponseMultiError is an error wrapping multiple validation errors returned by WriteResponse.ValidateAll() if the designated constraints aren't met.

func (WriteResponseMultiError) AllErrors 

func (m WriteResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (WriteResponseMultiError) Error 

func (m WriteResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type WriteResponseValidationError 

type WriteResponseValidationError struct {
	// contains filtered or unexported fields
}

WriteResponseValidationError is the validation error returned by WriteResponse.Validate if the designated constraints aren't met.

func (WriteResponseValidationError) Cause 

func (e WriteResponseValidationError) Cause() error

Cause function returns cause value.

func (WriteResponseValidationError) Error 

func (e WriteResponseValidationError) Error() string

Error satisfies the builtin error interface

func (WriteResponseValidationError) ErrorName 

func (e WriteResponseValidationError) ErrorName() string

ErrorName returns error name.

func (WriteResponseValidationError) Field 

func (e WriteResponseValidationError) Field() string

Field function returns field value.

func (WriteResponseValidationError) Key 

func (e WriteResponseValidationError) Key() bool

Key function returns key value.

func (WriteResponseValidationError) Reason 

func (e WriteResponseValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.