genproto: google.golang.org/genproto/googleapis/bytestream Index | Files

package bytestream

import "google.golang.org/genproto/googleapis/bytestream"

Index

Package Files

bytestream.pb.go

func RegisterByteStreamServer Uses

func RegisterByteStreamServer(s *grpc.Server, srv ByteStreamServer)

type ByteStreamClient Uses

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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewByteStreamClient Uses

func NewByteStreamClient(cc *grpc.ClientConn) ByteStreamClient

type ByteStreamServer Uses

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)
}

ByteStreamServer is the server API for ByteStream service.

type ByteStream_ReadClient Uses

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

type ByteStream_ReadServer Uses

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

type ByteStream_WriteClient Uses

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

type ByteStream_WriteServer Uses

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

type QueryWriteStatusRequest Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Request object for ByteStream.QueryWriteStatus.

func (*QueryWriteStatusRequest) Descriptor Uses

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

func (*QueryWriteStatusRequest) GetResourceName Uses

func (m *QueryWriteStatusRequest) GetResourceName() string

func (*QueryWriteStatusRequest) ProtoMessage Uses

func (*QueryWriteStatusRequest) ProtoMessage()

func (*QueryWriteStatusRequest) Reset Uses

func (m *QueryWriteStatusRequest) Reset()

func (*QueryWriteStatusRequest) String Uses

func (m *QueryWriteStatusRequest) String() string

func (*QueryWriteStatusRequest) XXX_DiscardUnknown Uses

func (m *QueryWriteStatusRequest) XXX_DiscardUnknown()

func (*QueryWriteStatusRequest) XXX_Marshal Uses

func (m *QueryWriteStatusRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryWriteStatusRequest) XXX_Merge Uses

func (m *QueryWriteStatusRequest) XXX_Merge(src proto.Message)

func (*QueryWriteStatusRequest) XXX_Size Uses

func (m *QueryWriteStatusRequest) XXX_Size() int

func (*QueryWriteStatusRequest) XXX_Unmarshal Uses

func (m *QueryWriteStatusRequest) XXX_Unmarshal(b []byte) error

type QueryWriteStatusResponse Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Response object for ByteStream.QueryWriteStatus.

func (*QueryWriteStatusResponse) Descriptor Uses

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

func (*QueryWriteStatusResponse) GetCommittedSize Uses

func (m *QueryWriteStatusResponse) GetCommittedSize() int64

func (*QueryWriteStatusResponse) GetComplete Uses

func (m *QueryWriteStatusResponse) GetComplete() bool

func (*QueryWriteStatusResponse) ProtoMessage Uses

func (*QueryWriteStatusResponse) ProtoMessage()

func (*QueryWriteStatusResponse) Reset Uses

func (m *QueryWriteStatusResponse) Reset()

func (*QueryWriteStatusResponse) String Uses

func (m *QueryWriteStatusResponse) String() string

func (*QueryWriteStatusResponse) XXX_DiscardUnknown Uses

func (m *QueryWriteStatusResponse) XXX_DiscardUnknown()

func (*QueryWriteStatusResponse) XXX_Marshal Uses

func (m *QueryWriteStatusResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryWriteStatusResponse) XXX_Merge Uses

func (m *QueryWriteStatusResponse) XXX_Merge(src proto.Message)

func (*QueryWriteStatusResponse) XXX_Size Uses

func (m *QueryWriteStatusResponse) XXX_Size() int

func (*QueryWriteStatusResponse) XXX_Unmarshal Uses

func (m *QueryWriteStatusResponse) XXX_Unmarshal(b []byte) error

type ReadRequest Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Request object for ByteStream.Read.

func (*ReadRequest) Descriptor Uses

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

func (*ReadRequest) GetReadLimit Uses

func (m *ReadRequest) GetReadLimit() int64

func (*ReadRequest) GetReadOffset Uses

func (m *ReadRequest) GetReadOffset() int64

func (*ReadRequest) GetResourceName Uses

func (m *ReadRequest) GetResourceName() string

func (*ReadRequest) ProtoMessage Uses

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) Reset Uses

func (m *ReadRequest) Reset()

func (*ReadRequest) String Uses

func (m *ReadRequest) String() string

func (*ReadRequest) XXX_DiscardUnknown Uses

func (m *ReadRequest) XXX_DiscardUnknown()

func (*ReadRequest) XXX_Marshal Uses

func (m *ReadRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ReadRequest) XXX_Merge Uses

func (m *ReadRequest) XXX_Merge(src proto.Message)

func (*ReadRequest) XXX_Size Uses

func (m *ReadRequest) XXX_Size() int

func (*ReadRequest) XXX_Unmarshal Uses

func (m *ReadRequest) XXX_Unmarshal(b []byte) error

type ReadResponse Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Response object for ByteStream.Read.

func (*ReadResponse) Descriptor Uses

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

func (*ReadResponse) GetData Uses

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

func (*ReadResponse) ProtoMessage Uses

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) Reset Uses

func (m *ReadResponse) Reset()

func (*ReadResponse) String Uses

func (m *ReadResponse) String() string

func (*ReadResponse) XXX_DiscardUnknown Uses

func (m *ReadResponse) XXX_DiscardUnknown()

func (*ReadResponse) XXX_Marshal Uses

func (m *ReadResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ReadResponse) XXX_Merge Uses

func (m *ReadResponse) XXX_Merge(src proto.Message)

func (*ReadResponse) XXX_Size Uses

func (m *ReadResponse) XXX_Size() int

func (*ReadResponse) XXX_Unmarshal Uses

func (m *ReadResponse) XXX_Unmarshal(b []byte) error

type UnimplementedByteStreamServer Uses

type UnimplementedByteStreamServer struct {
}

UnimplementedByteStreamServer can be embedded to have forward compatible implementations.

func (*UnimplementedByteStreamServer) QueryWriteStatus Uses

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

func (*UnimplementedByteStreamServer) Read Uses

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

func (*UnimplementedByteStreamServer) Write Uses

func (*UnimplementedByteStreamServer) Write(srv ByteStream_WriteServer) error

type WriteRequest Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Request object for ByteStream.Write.

func (*WriteRequest) Descriptor Uses

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

func (*WriteRequest) GetData Uses

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

func (*WriteRequest) GetFinishWrite Uses

func (m *WriteRequest) GetFinishWrite() bool

func (*WriteRequest) GetResourceName Uses

func (m *WriteRequest) GetResourceName() string

func (*WriteRequest) GetWriteOffset Uses

func (m *WriteRequest) GetWriteOffset() int64

func (*WriteRequest) ProtoMessage Uses

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) Reset Uses

func (m *WriteRequest) Reset()

func (*WriteRequest) String Uses

func (m *WriteRequest) String() string

func (*WriteRequest) XXX_DiscardUnknown Uses

func (m *WriteRequest) XXX_DiscardUnknown()

func (*WriteRequest) XXX_Marshal Uses

func (m *WriteRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteRequest) XXX_Merge Uses

func (m *WriteRequest) XXX_Merge(src proto.Message)

func (*WriteRequest) XXX_Size Uses

func (m *WriteRequest) XXX_Size() int

func (*WriteRequest) XXX_Unmarshal Uses

func (m *WriteRequest) XXX_Unmarshal(b []byte) error

type WriteResponse Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Response object for ByteStream.Write.

func (*WriteResponse) Descriptor Uses

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

func (*WriteResponse) GetCommittedSize Uses

func (m *WriteResponse) GetCommittedSize() int64

func (*WriteResponse) ProtoMessage Uses

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) Reset Uses

func (m *WriteResponse) Reset()

func (*WriteResponse) String Uses

func (m *WriteResponse) String() string

func (*WriteResponse) XXX_DiscardUnknown Uses

func (m *WriteResponse) XXX_DiscardUnknown()

func (*WriteResponse) XXX_Marshal Uses

func (m *WriteResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteResponse) XXX_Merge Uses

func (m *WriteResponse) XXX_Merge(src proto.Message)

func (*WriteResponse) XXX_Size Uses

func (m *WriteResponse) XXX_Size() int

func (*WriteResponse) XXX_Unmarshal Uses

func (m *WriteResponse) XXX_Unmarshal(b []byte) error

Package bytestream imports 9 packages (graph) and is imported by 36 packages. Updated 2019-10-10. Refresh now. Tools for package owners.