google_bytestream

Documentation

Index

• type QueryWriteStatusRequest
  • func (*QueryWriteStatusRequest) Descriptor() ([]byte, []int)
  • func (m *QueryWriteStatusRequest) GetResourceName() string
  • func (*QueryWriteStatusRequest) ProtoMessage()
  • func (m *QueryWriteStatusRequest) Reset()
  • func (m *QueryWriteStatusRequest) String() string
• type QueryWriteStatusResponse
  • func (*QueryWriteStatusResponse) Descriptor() ([]byte, []int)
  • func (m *QueryWriteStatusResponse) GetCommittedSize() int64
  • func (m *QueryWriteStatusResponse) GetComplete() bool
  • func (*QueryWriteStatusResponse) ProtoMessage()
  • func (m *QueryWriteStatusResponse) Reset()
  • func (m *QueryWriteStatusResponse) String() string
• type ReadRequest
  • func (*ReadRequest) Descriptor() ([]byte, []int)
  • func (m *ReadRequest) GetReadLimit() int64
  • func (m *ReadRequest) GetReadOffset() int64
  • func (m *ReadRequest) GetResourceName() string
  • func (*ReadRequest) ProtoMessage()
  • func (m *ReadRequest) Reset()
  • func (m *ReadRequest) String() string
• type ReadResponse
  • func (*ReadResponse) Descriptor() ([]byte, []int)
  • func (m *ReadResponse) GetData() []byte
  • func (*ReadResponse) ProtoMessage()
  • func (m *ReadResponse) Reset()
  • func (m *ReadResponse) String() string
• type WriteRequest
  • func (*WriteRequest) Descriptor() ([]byte, []int)
  • func (m *WriteRequest) GetData() []byte
  • func (m *WriteRequest) GetFinishWrite() bool
  • func (m *WriteRequest) GetResourceName() string
  • func (m *WriteRequest) GetWriteOffset() int64
  • func (*WriteRequest) ProtoMessage()
  • func (m *WriteRequest) Reset()
  • func (m *WriteRequest) String() string
• type WriteResponse
  • func (*WriteResponse) Descriptor() ([]byte, []int)
  • func (m *WriteResponse) GetCommittedSize() int64
  • func (*WriteResponse) ProtoMessage()
  • func (m *WriteResponse) Reset()
  • func (m *WriteResponse) String() string

Types

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"`
}

Request object for ByteStream.QueryWriteStatus.

func (*QueryWriteStatusRequest) Descriptor

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

func (*QueryWriteStatusRequest) GetResourceName

func (m *QueryWriteStatusRequest) GetResourceName() string

func (*QueryWriteStatusRequest) ProtoMessage

func (*QueryWriteStatusRequest) ProtoMessage()

func (*QueryWriteStatusRequest) Reset

func (m *QueryWriteStatusRequest) Reset()

func (*QueryWriteStatusRequest) String

func (m *QueryWriteStatusRequest) String() string

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"`
}

Response object for ByteStream.QueryWriteStatus.

func (*QueryWriteStatusResponse) Descriptor

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

func (*QueryWriteStatusResponse) GetCommittedSize

func (m *QueryWriteStatusResponse) GetCommittedSize() int64

func (*QueryWriteStatusResponse) GetComplete

func (m *QueryWriteStatusResponse) GetComplete() bool

func (*QueryWriteStatusResponse) ProtoMessage

func (*QueryWriteStatusResponse) ProtoMessage()

func (*QueryWriteStatusResponse) Reset

func (m *QueryWriteStatusResponse) Reset()

func (*QueryWriteStatusResponse) String

func (m *QueryWriteStatusResponse) String() string

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"`
}

Request object for ByteStream.Read.

func (*ReadRequest) Descriptor

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

func (*ReadRequest) GetReadLimit

func (m *ReadRequest) GetReadLimit() int64

func (*ReadRequest) GetReadOffset

func (m *ReadRequest) GetReadOffset() int64

func (*ReadRequest) GetResourceName

func (m *ReadRequest) GetResourceName() string

func (*ReadRequest) ProtoMessage

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) Reset

func (m *ReadRequest) Reset()

func (*ReadRequest) String

func (m *ReadRequest) String() string

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"`
}

Response object for ByteStream.Read.

func (*ReadResponse) Descriptor

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

func (*ReadResponse) GetData

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

func (*ReadResponse) ProtoMessage

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) Reset

func (m *ReadResponse) Reset()

func (*ReadResponse) String

func (m *ReadResponse) String() string

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"`
}

Request object for ByteStream.Write.

func (*WriteRequest) Descriptor

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

func (*WriteRequest) GetData

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

func (*WriteRequest) GetFinishWrite

func (m *WriteRequest) GetFinishWrite() bool

func (*WriteRequest) GetResourceName

func (m *WriteRequest) GetResourceName() string

func (*WriteRequest) GetWriteOffset

func (m *WriteRequest) GetWriteOffset() int64

func (*WriteRequest) ProtoMessage

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) Reset

func (m *WriteRequest) Reset()

func (*WriteRequest) String

func (m *WriteRequest) String() string

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"`
}

Response object for ByteStream.Write.

func (*WriteResponse) Descriptor

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

func (*WriteResponse) GetCommittedSize

func (m *WriteResponse) GetCommittedSize() int64

func (*WriteResponse) ProtoMessage

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) Reset

func (m *WriteResponse) Reset()

func (*WriteResponse) String

func (m *WriteResponse) String() string