linkv1beta1

type CreatePublicShareRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The unique identifier for the shared storage resource.
	ResourceInfo *v1beta11.ResourceInfo `protobuf:"bytes,2,opt,name=resource_info,json=resourceInfo,proto3" json:"resource_info,omitempty"`
	// REQUIRED.
	// The restrictions to apply to the share.
	Grant *Grant `protobuf:"bytes,3,opt,name=grant,proto3" json:"grant,omitempty"`
	// OPTIONAL
	// The description to add to the share.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// OPTIONAL
	// Indicates a share used for internal usage,
	// not exposed by a ListPublicShares.
	Internal bool `protobuf:"varint,5,opt,name=internal,proto3" json:"internal,omitempty"`
	// OPTIONAL
	// Whether to notify the owner of a share when a file is uploaded to it.
	NotifyUploads bool `protobuf:"varint,6,opt,name=notify_uploads,json=notifyUploads,proto3" json:"notify_uploads,omitempty"`
	// OPTIONAL
	// Comma-separated list of extra email addresses to notify when a file is
	// uploaded to the share.
	NotifyUploadsExtraRecipients string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

type CreatePublicShareResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The created share.
	Share *PublicShare `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"`
	// contains filtered or unexported fields
}

type GetPublicShareByTokenRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The unlisted token to identify the public share.
	Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	// OPTIONAL.
	// The public link can require authentication.
	Authentication *PublicShareAuthentication `protobuf:"bytes,3,opt,name=authentication,proto3" json:"authentication,omitempty"`
	// OPTIONAL.
	// If a signature should be included in the share.
	Sign bool `protobuf:"varint,4,opt,name=sign,proto3" json:"sign,omitempty"`
	// contains filtered or unexported fields
}

type GetPublicShareByTokenResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The share.
	Share *PublicShare `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"`
	// OPTIONAL.
	// The share password hash.
	//
	// Deprecated: Marked as deprecated in cs3/sharing/link/v1beta1/link_api.proto.
	PasswordHash string `protobuf:"bytes,4,opt,name=password_hash,json=passwordHash,proto3" json:"password_hash,omitempty"`
	// contains filtered or unexported fields
}

type GetPublicShareRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The reference to which the action should be performed.
	Ref *PublicShareReference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// OPTIONAL.
	// If a signature should be included in the share.
	Sign bool `protobuf:"varint,3,opt,name=sign,proto3" json:"sign,omitempty"`
	// contains filtered or unexported fields
}

type GetPublicShareResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The share.
	Share *PublicShare `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"`
	// contains filtered or unexported fields
}

type Grant struct {

	// REQUIRED.
	// The permissions for the share.
	Permissions *PublicSharePermissions `protobuf:"bytes,1,opt,name=permissions,proto3" json:"permissions,omitempty"`
	// OPTIONAL.
	// A password to protect the access to the public share.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// OPTIONAL.
	// An expiration date to protect the access to the public share.
	Expiration *v1beta12.Timestamp `protobuf:"bytes,3,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// contains filtered or unexported fields
}

type LinkAPIClient interface {
	// Creates a new share.
	// MUST return CODE_NOT_FOUND if the resource reference does not exist.
	// MUST return CODE_ALREADY_EXISTS if the share already exists for the 4-tuple consisting of
	// (owner, shared_resource, grantee).
	// New shares MUST be created in the state SHARE_STATE_PENDING.
	CreatePublicShare(ctx context.Context, in *CreatePublicShareRequest, opts ...grpc.CallOption) (*CreatePublicShareResponse, error)
	// Removes a share.
	// MUST return CODE_NOT_FOUND if the share reference does not exist.
	RemovePublicShare(ctx context.Context, in *RemovePublicShareRequest, opts ...grpc.CallOption) (*RemovePublicShareResponse, error)
	// Gets share information for a single share.
	// MUST return CODE_NOT_FOUND if the share reference does not exist.
	GetPublicShare(ctx context.Context, in *GetPublicShareRequest, opts ...grpc.CallOption) (*GetPublicShareResponse, error)
	// Gets share information for a single share by its unlisted token.
	// MUST return CODE_NOT_FOUND if the share does not exist.
	GetPublicShareByToken(ctx context.Context, in *GetPublicShareByTokenRequest, opts ...grpc.CallOption) (*GetPublicShareByTokenResponse, error)
	// List the shares the authenticated principal has created,
	// both as owner and creator. If a filter is specified, only
	// shares satisfying the filter MUST be returned.
	ListPublicShares(ctx context.Context, in *ListPublicSharesRequest, opts ...grpc.CallOption) (*ListPublicSharesResponse, error)
	// Updates a share.
	// MUST return CODE_NOT_FOUND if the share reference does not exist.
	UpdatePublicShare(ctx context.Context, in *UpdatePublicShareRequest, opts ...grpc.CallOption) (*UpdatePublicShareResponse, error)
}

type LinkAPIServer interface {
	// Creates a new share.
	// MUST return CODE_NOT_FOUND if the resource reference does not exist.
	// MUST return CODE_ALREADY_EXISTS if the share already exists for the 4-tuple consisting of
	// (owner, shared_resource, grantee).
	// New shares MUST be created in the state SHARE_STATE_PENDING.
	CreatePublicShare(context.Context, *CreatePublicShareRequest) (*CreatePublicShareResponse, error)
	// Removes a share.
	// MUST return CODE_NOT_FOUND if the share reference does not exist.
	RemovePublicShare(context.Context, *RemovePublicShareRequest) (*RemovePublicShareResponse, error)
	// Gets share information for a single share.
	// MUST return CODE_NOT_FOUND if the share reference does not exist.
	GetPublicShare(context.Context, *GetPublicShareRequest) (*GetPublicShareResponse, error)
	// Gets share information for a single share by its unlisted token.
	// MUST return CODE_NOT_FOUND if the share does not exist.
	GetPublicShareByToken(context.Context, *GetPublicShareByTokenRequest) (*GetPublicShareByTokenResponse, error)
	// List the shares the authenticated principal has created,
	// both as owner and creator. If a filter is specified, only
	// shares satisfying the filter MUST be returned.
	ListPublicShares(context.Context, *ListPublicSharesRequest) (*ListPublicSharesResponse, error)
	// Updates a share.
	// MUST return CODE_NOT_FOUND if the share reference does not exist.
	UpdatePublicShare(context.Context, *UpdatePublicShareRequest) (*UpdatePublicShareResponse, error)
}

type ListPublicSharesRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// OPTIONAL.
	// The list of filters to apply if any.
	Filters []*ListPublicSharesRequest_Filter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
	// OPTIONAL.
	// If a signature should be included in the share.
	Sign bool `protobuf:"varint,3,opt,name=sign,proto3" json:"sign,omitempty"`
	// OPTIONAL.
	// Clients use this field to specify the maximum number of results to be returned by the server.
	// The server may further constrain the maximum number of results returned in a single page.
	// If the page_size is 0, the server will decide the number of results to be returned.
	// see https://cloud.google.com/apis/design/design_patterns#list_pagination
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// OPTIONAL.
	// The client uses this field to request a specific page of the list results.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

type ListPublicSharesRequest_Filter struct {
	Type ListPublicSharesRequest_Filter_Type `` /* 128-byte string literal not displayed */
	// Types that are assignable to Term:
	//
	//	*ListPublicSharesRequest_Filter_ResourceId
	//	*ListPublicSharesRequest_Filter_Owner
	//	*ListPublicSharesRequest_Filter_Creator
	Term isListPublicSharesRequest_Filter_Term `protobuf_oneof:"term"`
	// contains filtered or unexported fields
}

type ListPublicSharesRequest_Filter_Creator struct {
	Creator *v1beta13.UserId `protobuf:"bytes,5,opt,name=creator,proto3,oneof"`
}

type ListPublicSharesRequest_Filter_Owner struct {
	Owner *v1beta13.UserId `protobuf:"bytes,4,opt,name=owner,proto3,oneof"`
}

type ListPublicSharesRequest_Filter_ResourceId struct {
	ResourceId *v1beta11.ResourceId `protobuf:"bytes,3,opt,name=resource_id,json=resourceId,proto3,oneof"`
}

type ListPublicSharesRequest_Filter_Type int32

type ListPublicSharesResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The list of shares.
	Share []*PublicShare `protobuf:"bytes,3,rep,name=share,proto3" json:"share,omitempty"`
	// OPTIONAL.
	// This field represents the pagination token to retrieve the next page of results.
	// If the value is "", it means no further results for the request.
	// see https://cloud.google.com/apis/design/design_patterns#list_pagination
	NextPageToken string `protobuf:"bytes,4,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type PublicShare struct {

	// REQUIRED.
	// Opaque unique identifier of the share.
	Id *PublicShareId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// REQUIRED.
	// The unlisted token to give public access
	// to the public share.
	Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	// REQUIRED.
	// Unique identifier of the shared resource.
	ResourceId *v1beta1.ResourceId `protobuf:"bytes,3,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	// REQUIRED.
	// Permissions for the grantee to use
	// the resource.
	Permissions *PublicSharePermissions `protobuf:"bytes,4,opt,name=permissions,proto3" json:"permissions,omitempty"`
	// REQUIRED.
	// Uniquely identifies the owner of the share
	// (the resource owner at the time of creating the share).
	// In case the ownership of the underlying resource changes
	// the share owner field MAY change to reflect the change of ownsership.
	Owner *v1beta11.UserId `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"`
	// REQUIRED.
	// Uniquely identifies a principal who initiates the share creation.
	// A creator can create shares on behalf of the owner (because of re-sharing,
	// because belonging to special groups, ...).
	// Creator and owner often result in being the same principal.
	Creator *v1beta11.UserId `protobuf:"bytes,6,opt,name=creator,proto3" json:"creator,omitempty"`
	// REQUIRED.
	// Creation time of the share.
	Ctime *v1beta12.Timestamp `protobuf:"bytes,7,opt,name=ctime,proto3" json:"ctime,omitempty"`
	// REQUIRED.
	// Last modification time of the share.
	Mtime *v1beta12.Timestamp `protobuf:"bytes,8,opt,name=mtime,proto3" json:"mtime,omitempty"`
	// REQUIRED.
	// Determines if the public share is password protected or not.
	PasswordProtected bool `protobuf:"varint,9,opt,name=password_protected,json=passwordProtected,proto3" json:"password_protected,omitempty"`
	// OPTIONAL.
	// The expiration time for the public share.
	Expiration *v1beta12.Timestamp `protobuf:"bytes,10,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// OPTIONAL.
	// Display name for the shared resource (such as file, directory basename or any
	// user defined name).
	// The display name MAY be different than the actual resource basename.
	// This field is only useful for informational purposes, like for example,
	// setting the window title in a public share HTML page.
	DisplayName string `protobuf:"bytes,11,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// OPTIONAL.
	// A time constrained token with which
	// GetPublicSharebyToken requests can be
	// authenticated.
	Signature *ShareSignature `protobuf:"bytes,12,opt,name=signature,proto3" json:"signature,omitempty"`
	// OPTIONAL
	// A bool value indicating if the link is the quicklink
	// the server will enforce a maximum of 1 quicklink per resource
	Quicklink bool `protobuf:"varint,13,opt,name=quicklink,proto3" json:"quicklink,omitempty"`
	// OPTIONAL
	// Description of the share.
	Description string `protobuf:"bytes,14,opt,name=description,proto3" json:"description,omitempty"`
	// OPTIONAL
	// Whether to notify the owner of a share when a file is uploaded to it.
	NotifyUploads bool `protobuf:"varint,15,opt,name=notify_uploads,json=notifyUploads,proto3" json:"notify_uploads,omitempty"`
	// OPTIONAL
	// Comma-separated list of extra email addresses to notify when a file is
	// uploaded to the share.
	NotifyUploadsExtraRecipients string `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

type PublicShareAuthentication struct {

	// Types that are assignable to Spec:
	//
	//	*PublicShareAuthentication_Password
	//	*PublicShareAuthentication_Signature
	Spec isPublicShareAuthentication_Spec `protobuf_oneof:"spec"`
	// contains filtered or unexported fields
}

type PublicShareAuthentication_Password struct {
	// The password of the share.
	Password string `protobuf:"bytes,1,opt,name=password,proto3,oneof"`
}

type PublicShareAuthentication_Signature struct {
	// The signature issued by GetPublicShareByToken.
	Signature *ShareSignature `protobuf:"bytes,2,opt,name=signature,proto3,oneof"`
}

type PublicShareId struct {

	// REQUIRED.
	// The internal id used by service implementor to
	// uniquely identity the share in the internal
	// implementation of the service.
	OpaqueId string `protobuf:"bytes,2,opt,name=opaque_id,json=opaqueId,proto3" json:"opaque_id,omitempty"`
	// contains filtered or unexported fields
}

type PublicSharePermissions struct {
	Permissions *v1beta1.ResourcePermissions `protobuf:"bytes,1,opt,name=permissions,proto3" json:"permissions,omitempty"` // TODO(labkode): additional permissions for shares like re-sharing
	// contains filtered or unexported fields
}

type PublicShareReference struct {

	// REQUIRED.
	// One of the specifications MUST be specified.
	//
	// Types that are assignable to Spec:
	//
	//	*PublicShareReference_Id
	//	*PublicShareReference_Token
	Spec isPublicShareReference_Spec `protobuf_oneof:"spec"`
	// contains filtered or unexported fields
}

type PublicShareReference_Id struct {
	// The id of the share.
	Id *PublicShareId `protobuf:"bytes,1,opt,name=id,proto3,oneof"`
}

type PublicShareReference_Token struct {
	// The token to identify the public share.
	Token string `protobuf:"bytes,2,opt,name=token,proto3,oneof"`
}

type RemovePublicShareRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The reference to which the action should be performed.
	Ref *PublicShareReference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// contains filtered or unexported fields
}

type RemovePublicShareResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

type ShareSignature struct {

	// REQUIRED.
	// The signature value.
	Signature string `protobuf:"bytes,1,opt,name=signature,proto3" json:"signature,omitempty"`
	// REQUIRED.
	// The time until the signature becomes invalid.
	SignatureExpiration *v1beta12.Timestamp `protobuf:"bytes,2,opt,name=signature_expiration,json=signatureExpiration,proto3" json:"signature_expiration,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedLinkAPIServer struct {
}

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

type UpdatePublicShareRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // REQUIRED.
	// REQUIRED.
	// The reference to the public share.
	Ref    *PublicShareReference            `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"` // Available fields to update.
	Update *UpdatePublicShareRequest_Update `protobuf:"bytes,3,opt,name=update,proto3" json:"update,omitempty"`
	// contains filtered or unexported fields
}

type UpdatePublicShareRequest_Update struct {

	// REQUIRED.
	// Defines the field to update.
	Type UpdatePublicShareRequest_Update_Type `` /* 129-byte string literal not displayed */
	// REQUIRED.
	// Contains the field that will be updated.
	Grant *Grant `protobuf:"bytes,4,opt,name=grant,proto3" json:"grant,omitempty"`
	// OPTIONAL
	// Defines the public link display name.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// OPTIONAL
	// Defines the public link description.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// OPTIONAL
	// Whether to notify the owner of a share when a file is uploaded to it.
	NotifyUploads bool `protobuf:"varint,7,opt,name=notify_uploads,json=notifyUploads,proto3" json:"notify_uploads,omitempty"`
	// OPTIONAL
	// Comma-separated list of extra email addresses to notify when a file is
	// uploaded to the share.
	NotifyUploadsExtraRecipients string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

type UpdatePublicShareRequest_Update_Type int32

type UpdatePublicShareResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The updated public share.
	Share *PublicShare `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"`
	// contains filtered or unexported fields
}