api

type BlockMetadata struct {

	// This is the zero based byte position in the volume or snapshot,
	// measured from the start of the object.
	// This field is REQUIRED.
	ByteOffset int64 `protobuf:"varint,1,opt,name=byte_offset,json=byteOffset,proto3" json:"byte_offset,omitempty"`
	// This is the size of the data range.
	// size_bytes will be greater than zero.
	// This field is REQUIRED.
	SizeBytes int64 `protobuf:"varint,2,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// contains filtered or unexported fields
}

type BlockMetadataType int32

type GetMetadataAllocatedRequest struct {

	// This field specifies an audience scoped authentication token presented by client.
	// This token is used to authenticate and authorize the request at server side.
	// This field is REQUIRED.
	SecurityToken string `protobuf:"bytes,1,opt,name=security_token,json=securityToken,proto3" json:"security_token,omitempty"`
	// This field indicates the Namespace where the VolumeSnapshot exists.
	// This field is REQUIRED.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// This is the VolumeSnapshot object name against which changes
	// are to be computed.
	// This field is REQUIRED.
	SnapshotName string `protobuf:"bytes,3,opt,name=snapshot_name,json=snapshotName,proto3" json:"snapshot_name,omitempty"`
	// This indicates the zero based starting byte position in the volume
	// snapshot from which the result should be computed.
	// It is intended to be used to continue a previously interrupted
	// call.
	// The client SHOULD specify this value to be the offset of the byte
	// position immediately after the last byte of the last data range
	// received, if continuing an interrupted operation, or zero if not.
	// The sidecar will ensure that the returned response stream does not
	// contain BlockMetadata tuples that end before the requested
	// starting_offset: i.e. if S is the requested starting_offset, and
	// B0 is block_metadata[0] of the first message in the response
	// stream, then (S < B0.byte_offset + B0.size_bytes) will be true.
	// This field is REQUIRED.
	StartingOffset int64 `protobuf:"varint,4,opt,name=starting_offset,json=startingOffset,proto3" json:"starting_offset,omitempty"`
	// This is an optional parameter, and if non-zero it specifies the
	// maximum number of tuples to be returned in each
	// GetMetadataAllocatedResponse message returned by the RPC stream.
	// The sidecar will determine an appropriate value if 0, and is
	// always free to send less than the requested value.
	// This field is OPTIONAL.
	MaxResults int32 `protobuf:"varint,5,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
	// contains filtered or unexported fields
}

type GetMetadataAllocatedResponse struct {

	// This specifies the style used in the BlockMetadata sequence.
	// This value must be the same in all such messages returned by
	// the stream.
	// If block_metadata_type is FIXED_LENGTH, then the size_bytes field
	// of each message in the block_metadata list will be constant.
	// This field is REQUIRED.
	BlockMetadataType BlockMetadataType `` /* 155-byte string literal not displayed */
	// This returns the capacity of the underlying volume in bytes.
	// This value must be the same in all such messages returned by
	// the stream.
	// This field is REQUIRED.
	VolumeCapacityBytes int64 `protobuf:"varint,2,opt,name=volume_capacity_bytes,json=volumeCapacityBytes,proto3" json:"volume_capacity_bytes,omitempty"`
	// This is a list of data range tuples.
	// If the value of max_results in the GetMetadataAllocatedRequest
	// message is greater than zero, then the number of entries in this
	// list will be less than or equal to that value.
	// The sidecar will respect the value of starting_offset in the request.
	// The byte_offset fields of adjacent BlockMetadata messages
	// Will be strictly increasing and messages will not overlap:
	// i.e. for any two BlockMetadata messages, A and B, if A is returned
	// before B, then (A.byte_offset + A.size_bytes <= B.byte_offset)
	// will be true.
	// This will also be true if A and B are from block_metadata lists in
	// different GetMetadataAllocatedResponse messages in the gRPC stream.
	// This field is OPTIONAL.
	BlockMetadata []*BlockMetadata `protobuf:"bytes,3,rep,name=block_metadata,json=blockMetadata,proto3" json:"block_metadata,omitempty"`
	// contains filtered or unexported fields
}

type GetMetadataDeltaRequest struct {

	// This field specifies an audience scoped authentication token presented by client.
	// This token is used to authenticate and authorize the request at server side.
	// This field is REQUIRED.
	SecurityToken string `protobuf:"bytes,1,opt,name=security_token,json=securityToken,proto3" json:"security_token,omitempty"`
	// This field indicates the Namespace where the VolumeSnapshot exists.
	// This field is REQUIRED.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// This is the CSI handle of the base VolumeSnapshot object against which changes
	// are to be computed.
	// The value is passed on blindly to the CSI driver without any verification by
	// the sidecar.
	// A backup application must have obtained this value from the Status.SnapshotHandle
	// field of the VolumeSnapshotContent object associated with the base VolumeSnapshot
	// object at some time prior to making this request.
	// It is the backup application's responsibility to determine if the underlying CSI
	// driver requires the base VolumeSnapshot object to exist at the time that this
	// request is made, and take that into consideration in its snapshot retention policy.
	// This field is REQUIRED.
	BaseSnapshotId string `protobuf:"bytes,3,opt,name=base_snapshot_id,json=baseSnapshotId,proto3" json:"base_snapshot_id,omitempty"`
	// This is the name of a second VolumeSnapshot in the same volume,
	// created after the base snapshot.
	// This field is REQUIRED.
	TargetSnapshotName string `protobuf:"bytes,4,opt,name=target_snapshot_name,json=targetSnapshotName,proto3" json:"target_snapshot_name,omitempty"`
	// This indicates the zero based starting byte position in the volume
	// snapshot from which the result should be computed.
	// It is intended to be used to continue a previously interrupted
	// call.
	// The client SHOULD specify this value to be the offset of the byte
	// position immediately after the last byte of the last data range
	// received, if continuing an interrupted operation, or zero if not.
	// The sidecar will ensure that the returned response stream does not
	// contain BlockMetadata tuples that end before the requested
	// starting_offset: i.e. if S is the requested starting_offset, and
	// B0 is block_metadata[0] of the first message in the response
	// stream, then (S < B0.byte_offset + B0.size_bytes) will be true.
	// This field is REQUIRED.
	StartingOffset int64 `protobuf:"varint,5,opt,name=starting_offset,json=startingOffset,proto3" json:"starting_offset,omitempty"`
	// This is an optional parameter, and if non-zero it specifies the
	// maximum number of tuples to be returned in each
	// GetMetadataDeltaResponse message returned by the RPC stream.
	// The sidecar will determine an appropriate value if 0, and is
	// always free to send less than the requested value.
	// This field is OPTIONAL.
	MaxResults int32 `protobuf:"varint,6,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
	// contains filtered or unexported fields
}

type GetMetadataDeltaResponse struct {

	// This specifies the style used in the BlockMetadata sequence.
	// This value must be the same in all such messages returned by
	// the stream.
	// If block_metadata_type is FIXED_LENGTH, then the size_bytes field
	// of each message in the block_metadata list will be constant.
	// This field is REQUIRED.
	BlockMetadataType BlockMetadataType `` /* 155-byte string literal not displayed */
	// This returns the capacity of the underlying volume in bytes.
	// This value must be the same in all such messages returned by
	// the stream.
	// This field is REQUIRED.
	VolumeCapacityBytes int64 `protobuf:"varint,2,opt,name=volume_capacity_bytes,json=volumeCapacityBytes,proto3" json:"volume_capacity_bytes,omitempty"`
	// This is a list of data range tuples.
	// If the value of max_results in the GetMetadataDeltaRequest message
	// is greater than zero, then the number of entries in this list will
	// be less than or equal to that value.
	// The sidecar will respect the value of starting_offset in the request.
	// The byte_offset fields of adjacent BlockMetadata messages
	// Will be strictly increasing and messages will not overlap:
	// i.e. for any two BlockMetadata messages, A and B, if A is returned
	// before B, then (A.byte_offset + A.size_bytes <= B.byte_offset)
	// will be true.
	// This will also be true if A and B are from block_metadata lists in
	// different GetMetadataDeltaResponse messages in the gRPC stream.
	// This field is OPTIONAL.
	BlockMetadata []*BlockMetadata `protobuf:"bytes,3,rep,name=block_metadata,json=blockMetadata,proto3" json:"block_metadata,omitempty"`
	// contains filtered or unexported fields
}

type SnapshotMetadataClient interface {
	GetMetadataAllocated(ctx context.Context, in *GetMetadataAllocatedRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[GetMetadataAllocatedResponse], error)
	GetMetadataDelta(ctx context.Context, in *GetMetadataDeltaRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[GetMetadataDeltaResponse], error)
}

type SnapshotMetadataServer interface {
	GetMetadataAllocated(*GetMetadataAllocatedRequest, grpc.ServerStreamingServer[GetMetadataAllocatedResponse]) error
	GetMetadataDelta(*GetMetadataDeltaRequest, grpc.ServerStreamingServer[GetMetadataDeltaResponse]) error
	// contains filtered or unexported methods
}

type SnapshotMetadata_GetMetadataAllocatedClient = grpc.ServerStreamingClient[GetMetadataAllocatedResponse]

type SnapshotMetadata_GetMetadataAllocatedServer = grpc.ServerStreamingServer[GetMetadataAllocatedResponse]

type SnapshotMetadata_GetMetadataDeltaClient = grpc.ServerStreamingClient[GetMetadataDeltaResponse]

type SnapshotMetadata_GetMetadataDeltaServer = grpc.ServerStreamingServer[GetMetadataDeltaResponse]

type UnimplementedSnapshotMetadataServer struct{}

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