cosi

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

type AccessMode_Mode int32

type AuthenticationType struct {
	Type AuthenticationType_Type `protobuf:"varint,1,opt,name=type,proto3,enum=sigs.k8s.io.cosi.v1alpha2.AuthenticationType_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

type AuthenticationType_Type int32

type AzureBucketInfo struct {

	// ID of the Azure storage account.
	StorageAccount string `protobuf:"bytes,1,opt,name=storage_account,json=storageAccount,proto3" json:"storage_account,omitempty"`
	// contains filtered or unexported fields
}

type AzureCredentialInfo struct {

	// Azure access token.
	// Note that the Azure spec includes the resource URI as well as token in its definition.
	// https://learn.microsoft.com/en-us/azure/storage/common/media/storage-sas-overview/sas-storage-uri.svg
	AccessToken string `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
	// Expiry time of the access.
	// Empty if unset. Otherwise, date+time in ISO 8601 format.
	ExpiryTimestamp string `protobuf:"bytes,2,opt,name=expiry_timestamp,json=expiryTimestamp,proto3" json:"expiry_timestamp,omitempty"`
	// contains filtered or unexported fields
}

type CredentialInfo struct {

	// Credential info for S3 protocol access.
	S3 *S3CredentialInfo `protobuf:"bytes,1,opt,name=s3,proto3" json:"s3,omitempty"`
	// Credential info for Azure (Blob) protocol access.
	Azure *AzureCredentialInfo `protobuf:"bytes,2,opt,name=azure,proto3" json:"azure,omitempty"`
	// Credential info for Google Cloud Storage protocol access.
	Gcs *GcsCredentialInfo `protobuf:"bytes,3,opt,name=gcs,proto3" json:"gcs,omitempty"`
	// contains filtered or unexported fields
}

type DriverCreateBucketRequest struct {

	// REQUIRED. The suggested name for the backend bucket.
	// It serves two purposes:
	//  1. Suggested name - COSI WILL suggest a name that includes a UID component that is
	//     statistically likely to be globally unique.
	//  2. Idempotency - This name is generated by COSI to achieve idempotency. The Plugin SHOULD
	//     ensure that multiple DriverCreateBucket calls for the same name do not result in more
	//     than one Bucket being provisioned corresponding to the name.
	//     The COSI Sidecar WILL call DriverCreateBucket, with the same name, periodically to ensure
	//     the bucket exists.
	//     Using or appending random identifiers can lead to multiple unused buckets being created in
	//     the storage backend in the event of timing-related Driver/Sidecar failures or restarts.
	//
	// COSI WILL use DNS subdomain format (https://datatracker.ietf.org/doc/html/rfc1123).
	// It WILL contain contain no more than 253 characters, contain only lowercase alphanumeric
	// characters, '-' or '.', start with an alphanumeric character, and end with an alphanumeric
	// character.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// OPTIONAL. A list of all object storage protocols the provisioned bucket MUST support.
	// If none are given, the provisioner MAY provision with a set of default protocol(s) or return
	// `InvalidArgument` with a message indicating that it requires this input.
	// If any protocol cannot be supported, the Provisioner MUST return `InvalidArgument`.
	Protocols []*ObjectProtocol `protobuf:"bytes,2,rep,name=protocols,proto3" json:"protocols,omitempty"`
	// OPTIONAL. Plugin specific parameters passed in as opaque key-value pairs.
	// The Plugin is responsible for parsing and validating these parameters.
	Parameters map[string]string `` /* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

type DriverCreateBucketResponse struct {

	// REQUIRED. The unique identifier for the backend bucket known to the Provisioner.
	// This value WILL be used by COSI to make subsequent calls related to the bucket, so the
	// Provisioner MUST be able to correlate `bucket_id` to the backend bucket.
	// It is RECOMMENDED to use the backend storage system's bucket ID.
	BucketId string `protobuf:"bytes,1,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// REQUIRED: At least one protocol bucket info result MUST be non-nil.
	//
	// The primary purpose of this response is to indicate which protocols are supported for
	// subsequent DriverGrantBucketAccess requests referencing this provisioned bucket. A non-nil
	// bucket info corresponding to a protocol indicates support.
	//
	// The Provisioner MUST indicate support for the protocols in the request. It MAY indicate
	// support for more protocols than the request. It SHOULD indicate support for all supported
	// protocols. It MUST NOT indicate support (return a non-nil result) for unsupported protocols.
	//
	// The secondary purpose of this response is to report non-credential information about the
	// bucket. COSI does not expose this information to end-users until a subsequent
	// DriverGrantBucketAccess is provisioned referencing this bucket. Instead, the info is exposed
	// to administrators so that they might more easily debug errors in their configuration of COSI.
	// It is thus RECOMMENDED to return all relevant bucket info for all supported protocols.
	// However, the Provisioner MAY omit any or all bucket info fields as desired.
	Protocols *ObjectProtocolAndBucketInfo `protobuf:"bytes,2,opt,name=protocols,proto3" json:"protocols,omitempty"`
	// contains filtered or unexported fields
}

type DriverDeleteBucketRequest struct {

	// REQUIRED. The unique identifier for the existing backend bucket known to the Provisioner.
	BucketId string `protobuf:"bytes,1,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// OPTIONAL. Plugin specific parameters associated with the provisioned bucket.
	Parameters map[string]string `` /* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

type DriverGetExistingBucketRequest struct {

	// REQUIRED. The unique identifier for the existing backend bucket known to the Provisioner.
	// Provisioner MUST be able to correlate `bucket_id` to the backend bucket.
	// It is RECOMMENDED to use the backend storage system's bucket ID.
	ExistingBucketId string `protobuf:"bytes,1,opt,name=existing_bucket_id,json=existingBucketId,proto3" json:"existing_bucket_id,omitempty"`
	// OPTIONAL. A list of all object storage protocols the provisioned bucket MUST support.
	// If none are given, the provisioner MAY provision with a set of default protocol(s) or return
	// `InvalidArgument` with a message indicating that it requires this input.
	// If any protocol cannot be supported, the Provisioner MUST return `InvalidArgument`.
	Protocols []*ObjectProtocol `protobuf:"bytes,2,rep,name=protocols,proto3" json:"protocols,omitempty"`
	// OPTIONAL. Plugin specific parameters passed in as opaque key-value pairs.
	// The Plugin is responsible for parsing and validating these parameters.
	Parameters map[string]string `` /* 147-byte string literal not displayed */
	// contains filtered or unexported fields
}

type DriverGetExistingBucketResponse struct {

	// REQUIRED. The unique identifier for the backend bucket known to the Provisioner.
	// This value WILL be used by COSI to make subsequent calls related to the bucket, so the
	// Provisioner MUST be able to correlate `bucket_id` to the backend bucket.
	// It is RECOMMENDED to use the backend storage system's bucket ID.
	BucketId string `protobuf:"bytes,1,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// REQUIRED: At least one protocol bucket info result MUST be non-nil.
	//
	// The primary purpose of this response is to indicate which protocols are supported for
	// subsequent DriverGrantBucketAccess requests referencing this provisioned bucket. A non-nil
	// bucket info corresponding to a protocol indicates support.
	//
	// The Provisioner MUST indicate support for the protocols in the request. It MAY indicate
	// support for more protocols than the request. It SHOULD indicate support for all supported
	// protocols. It MUST NOT indicate support (return a non-nil result) for unsupported protocols.
	//
	// The secondary purpose of this response is to report non-credential information about the
	// bucket. COSI does not expose this information to end-users until a subsequent
	// DriverGrantBucketAccess is provisioned referencing this bucket. Instead, the info is exposed
	// to administrators so that they might more easily debug errors in their configuration of COSI.
	// It is thus RECOMMENDED to return all relevant bucket info for all supported protocols.
	// However, the Provisioner MAY omit any or all bucket info fields as desired.
	Protocols *ObjectProtocolAndBucketInfo `protobuf:"bytes,2,opt,name=protocols,proto3" json:"protocols,omitempty"`
	// contains filtered or unexported fields
}

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

type DriverGetInfoResponse struct {

	// REQUIRED. The unique name of the driver.
	// The name MUST follow domain name notation format
	// (https://tools.ietf.org/html/rfc1035#section-2.3.1). It SHOULD
	// include the plugin's host company name and the plugin name,
	// to minimize the possibility of collisions. It MUST be 63
	// characters or less, beginning and ending with an alphanumeric
	// character ([a-z0-9A-Z]) with dashes (-), dots (.), and
	// alphanumerics between.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A list of all object storage protocols supported by the driver.
	// At least one protocol is REQUIRED.
	SupportedProtocols []*ObjectProtocol `protobuf:"bytes,2,rep,name=supported_protocols,json=supportedProtocols,proto3" json:"supported_protocols,omitempty"`
	// contains filtered or unexported fields
}

type DriverGrantBucketAccessRequest struct {

	// REQUIRED. The suggested name for the backend bucket access.
	// It serves two purposes:
	//  1. Suggested name - COSI WILL suggest a name that includes a UID component that is
	//     statistically likely to be globally unique.
	//  2. Idempotency - This name is generated by COSI to achieve idempotency. The Plugin SHOULD
	//     ensure that multiple DriverGrantBucketAccess calls for the same name do not result in more
	//     than one Bucket being provisioned corresponding to the name.
	//     The COSI Sidecar WILL call DriverGrantBucketAccess, with the same name, periodically to
	//     ensure the bucket exists.
	//     Using or appending random identifiers can lead to multiple unused buckets being created in
	//     the storage backend in the event of timing-related Driver/Sidecar failures or restarts.
	//
	// COSI WILL use DNS subdomain format (https://datatracker.ietf.org/doc/html/rfc1123).
	// It WILL contain contain no more than 253 characters, contain only lowercase alphanumeric
	// characters, '-' or '.', start with an alphanumeric character, and end with an alphanumeric
	// character.
	AccountName string `protobuf:"bytes,1,opt,name=account_name,json=accountName,proto3" json:"account_name,omitempty"`
	// REQUIRED. The object storage protocol the provisioned access MUST support.
	// If the protocol cannot be supported, the Provisioner MUST return `InvalidArgument`.
	Protocol *ObjectProtocol `protobuf:"bytes,2,opt,name=protocol,proto3" json:"protocol,omitempty"`
	// REQUIRED. The authentication type that the Provisioner MUST provision for this request.
	AuthenticationType *AuthenticationType `protobuf:"bytes,3,opt,name=authentication_type,json=authenticationType,proto3" json:"authentication_type,omitempty"`
	// REQUIRED when `authentication_type` is `SERVICE_ACCOUNT`.
	// OPTIONAL for all other authentication types.
	// COSI WILL NOT set this when the requested `authentication_type` is not `SERVICE_ACCOUNT`.
	ServiceAccountName string `protobuf:"bytes,4,opt,name=service_account_name,json=serviceAccountName,proto3" json:"service_account_name,omitempty"`
	// OPTIONAL. Plugin specific parameters passed in as opaque key-value pairs.
	// The Plugin is responsible for parsing and validating these parameters.
	Parameters map[string]string `` /* 147-byte string literal not displayed */
	// REQUIRED. Access to at least one bucket MUST be requested.
	Buckets []*DriverGrantBucketAccessRequest_AccessedBucket `protobuf:"bytes,6,rep,name=buckets,proto3" json:"buckets,omitempty"`
	// contains filtered or unexported fields
}

type DriverGrantBucketAccessRequest_AccessedBucket struct {

	// REQUIRED. The unique identifier for the backend bucket known to the Provisioner.
	BucketId string `protobuf:"bytes,1,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// REQUIRED. The read/write access mode that the Provisioner SHOULD provision for the bucket
	// associated with `bucket_id`.
	AccessMode *AccessMode `protobuf:"bytes,2,opt,name=access_mode,json=accessMode,proto3" json:"access_mode,omitempty"`
	// contains filtered or unexported fields
}

type DriverGrantBucketAccessResponse struct {

	// REQUIRED. The unique identifier for the backend access account known to the Provisioner.
	// This value WILL be used by COSI to make subsequent calls related to the access, so the
	// Provisioner MUST be able to correlate `account_id` to the backend access.
	// It is RECOMMENDED to use the backend storage system's bucket ID.
	AccountId string `protobuf:"bytes,1,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// REQUIRED. The Provisioner MUST return info for all `buckets` in the request.
	Buckets []*DriverGrantBucketAccessResponse_BucketInfo `protobuf:"bytes,2,rep,name=buckets,proto3" json:"buckets,omitempty"`
	// REQUIRED.
	Credentials *CredentialInfo `protobuf:"bytes,3,opt,name=credentials,proto3" json:"credentials,omitempty"`
	// contains filtered or unexported fields
}

type DriverGrantBucketAccessResponse_BucketInfo struct {

	// REQUIRED. The unique identifier for the backend bucket known to the Provisioner.
	BucketId string `protobuf:"bytes,1,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// REQUIRED: EXACTLY one protocol bucket info result MUST be non-nil.
	// The Provisioner MUST fill in all required bucket info for the requested protocol.
	// The Provisioner SHOULD fill in as much bucket info as is known given the parameters.
	// It MUST NOT support (return a non-nil result) non-requested protocols.
	// COSI WILL expose this information to users, and it WILL be treated as sensitive/secret
	// information.
	// COSI WILL not log the information or store it in plaintext.
	BucketInfo *ObjectProtocolAndBucketInfo `protobuf:"bytes,2,opt,name=bucket_info,json=bucketInfo,proto3" json:"bucket_info,omitempty"`
	// contains filtered or unexported fields
}

type DriverRevokeBucketAccessRequest struct {

	// REQUIRED. The unique identifier for the backend access account
	AccountId string `protobuf:"bytes,1,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
	// REQUIRED. The object storage protocol associated with the provisioned access.
	Protocol *ObjectProtocol `protobuf:"bytes,2,opt,name=protocol,proto3" json:"protocol,omitempty"`
	// REQUIRED. The authentication type associated with the provisioned access.
	AuthenticationType *AuthenticationType `protobuf:"bytes,3,opt,name=authentication_type,json=authenticationType,proto3" json:"authentication_type,omitempty"`
	// REQUIRED when `authentication_type` is `SERVICE_ACCOUNT`.
	// OPTIONAL for all other authentication types.
	// COSI WILL NOT set this when the requested `authentication_type` is not `SERVICE_ACCOUNT`.
	ServiceAccountName string `protobuf:"bytes,4,opt,name=service_account_name,json=serviceAccountName,proto3" json:"service_account_name,omitempty"`
	// OPTIONAL. Plugin specific parameters associated with the provisioned access.
	Parameters map[string]string `` /* 147-byte string literal not displayed */
	// REQUIRED. Buckets associated with the provisioned access.
	Buckets []*DriverRevokeBucketAccessRequest_AccessedBucket `protobuf:"bytes,6,rep,name=buckets,proto3" json:"buckets,omitempty"`
	// contains filtered or unexported fields
}

type DriverRevokeBucketAccessRequest_AccessedBucket struct {

	// REQUIRED. The unique identifier for the backend bucket known to the Provisioner.
	BucketId string `protobuf:"bytes,1,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// contains filtered or unexported fields
}

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

type GcsBucketInfo struct {

	// GCS project ID.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// GCS bucket name needed for client access.
	BucketName string `protobuf:"bytes,2,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// contains filtered or unexported fields
}

type GcsCredentialInfo struct {

	// HMAC access ID.
	AccessId string `protobuf:"bytes,1,opt,name=access_id,json=accessId,proto3" json:"access_id,omitempty"`
	// HMAC secret.
	AccessSecret string `protobuf:"bytes,2,opt,name=access_secret,json=accessSecret,proto3" json:"access_secret,omitempty"`
	// GCS private key name.
	PrivateKeyName string `protobuf:"bytes,3,opt,name=private_key_name,json=privateKeyName,proto3" json:"private_key_name,omitempty"`
	// GCS service account name.
	ServiceAccount string `protobuf:"bytes,4,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// contains filtered or unexported fields
}

type IdentityClient interface {
	// Retrieve the unique provisioner identity.
	DriverGetInfo(ctx context.Context, in *DriverGetInfoRequest, opts ...grpc.CallOption) (*DriverGetInfoResponse, error)
}

type IdentityServer interface {
	// Retrieve the unique provisioner identity.
	DriverGetInfo(context.Context, *DriverGetInfoRequest) (*DriverGetInfoResponse, error)
	// contains filtered or unexported methods
}

type ObjectProtocol struct {
	Type ObjectProtocol_Type `protobuf:"varint,1,opt,name=type,proto3,enum=sigs.k8s.io.cosi.v1alpha2.ObjectProtocol_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

type ObjectProtocolAndBucketInfo struct {

	// Protocol support and bucket info for S3 protocol access.
	S3 *S3BucketInfo `protobuf:"bytes,1,opt,name=s3,proto3" json:"s3,omitempty"`
	// Protocol support and bucket info for Azure (Blob) protocol access.
	Azure *AzureBucketInfo `protobuf:"bytes,2,opt,name=azure,proto3" json:"azure,omitempty"`
	// Protocol support and bucket info for Google Cloud Storage protocol access.
	Gcs *GcsBucketInfo `protobuf:"bytes,3,opt,name=gcs,proto3" json:"gcs,omitempty"`
	// contains filtered or unexported fields
}

type ObjectProtocol_Type int32

type ProvisionerClient interface {
	// Create the bucket in the backend.
	//
	// Important return codes:
	// - MUST return OK if a backend bucket with matching identity and parameters already exists.
	// - MUST return ALREADY_EXISTS if a backend bucket with matching identity exists but with incompatible parameters.
	DriverCreateBucket(ctx context.Context, in *DriverCreateBucketRequest, opts ...grpc.CallOption) (*DriverCreateBucketResponse, error)
	// Get details about a statically-provisioned bucket that should already exist in the OSP backend.
	//
	// Important return codes:
	// - MUST return OK if a backend bucket with matching identity and parameters already exists.
	// - MUST return NOT_FOUND if a bucket with matching identity does not exist.
	DriverGetExistingBucket(ctx context.Context, in *DriverGetExistingBucketRequest, opts ...grpc.CallOption) (*DriverGetExistingBucketResponse, error)
	// Delete the bucket in the backend.
	//
	// Important return codes:
	// - MUST return OK if the bucket has already been deleted.
	DriverDeleteBucket(ctx context.Context, in *DriverDeleteBucketRequest, opts ...grpc.CallOption) (*DriverDeleteBucketResponse, error)
	// Grant access to a bucket.
	//
	// Important return codes:
	// - MUST return OK if a principal with matching identity and parameters already exists.
	// - MUST return ALREADY_EXISTS if a principal with matching identity exists but with incompatible parameters.
	// - MUST return OUT_OF_RANGE - if (and only if) the driver/backend does not support multi-bucket access.
	DriverGrantBucketAccess(ctx context.Context, in *DriverGrantBucketAccessRequest, opts ...grpc.CallOption) (*DriverGrantBucketAccessResponse, error)
	// Revokes access to given bucket(s) from a principal.
	//
	// Important return codes:
	// - MUST return OK if access has already been removed from a principal.
	DriverRevokeBucketAccess(ctx context.Context, in *DriverRevokeBucketAccessRequest, opts ...grpc.CallOption) (*DriverRevokeBucketAccessResponse, error)
}

type ProvisionerServer interface {
	// Create the bucket in the backend.
	//
	// Important return codes:
	// - MUST return OK if a backend bucket with matching identity and parameters already exists.
	// - MUST return ALREADY_EXISTS if a backend bucket with matching identity exists but with incompatible parameters.
	DriverCreateBucket(context.Context, *DriverCreateBucketRequest) (*DriverCreateBucketResponse, error)
	// Get details about a statically-provisioned bucket that should already exist in the OSP backend.
	//
	// Important return codes:
	// - MUST return OK if a backend bucket with matching identity and parameters already exists.
	// - MUST return NOT_FOUND if a bucket with matching identity does not exist.
	DriverGetExistingBucket(context.Context, *DriverGetExistingBucketRequest) (*DriverGetExistingBucketResponse, error)
	// Delete the bucket in the backend.
	//
	// Important return codes:
	// - MUST return OK if the bucket has already been deleted.
	DriverDeleteBucket(context.Context, *DriverDeleteBucketRequest) (*DriverDeleteBucketResponse, error)
	// Grant access to a bucket.
	//
	// Important return codes:
	// - MUST return OK if a principal with matching identity and parameters already exists.
	// - MUST return ALREADY_EXISTS if a principal with matching identity exists but with incompatible parameters.
	// - MUST return OUT_OF_RANGE - if (and only if) the driver/backend does not support multi-bucket access.
	DriverGrantBucketAccess(context.Context, *DriverGrantBucketAccessRequest) (*DriverGrantBucketAccessResponse, error)
	// Revokes access to given bucket(s) from a principal.
	//
	// Important return codes:
	// - MUST return OK if access has already been removed from a principal.
	DriverRevokeBucketAccess(context.Context, *DriverRevokeBucketAccessRequest) (*DriverRevokeBucketAccessResponse, error)
	// contains filtered or unexported methods
}

type S3AddressingStyle struct {
	Style S3AddressingStyle_Style `protobuf:"varint,1,opt,name=style,proto3,enum=sigs.k8s.io.cosi.v1alpha2.S3AddressingStyle_Style" json:"style,omitempty"`
	// contains filtered or unexported fields
}

type S3AddressingStyle_Style int32

type S3BucketInfo struct {

	// S3 bucket ID needed for client access.
	BucketId string `protobuf:"bytes,1,opt,name=bucket_id,json=bucketId,proto3" json:"bucket_id,omitempty"`
	// S3 endpoint URL.
	Endpoint string `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Geographical region where the S3 server is running.
	Region string `protobuf:"bytes,3,opt,name=region,proto3" json:"region,omitempty"`
	// S3 addressing style. Drivers should return an addressing style that the backend supports and
	// that is most likely to have the broadest client support.
	// See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html
	AddressingStyle *S3AddressingStyle `protobuf:"bytes,4,opt,name=addressing_style,json=addressingStyle,proto3" json:"addressing_style,omitempty"`
	// contains filtered or unexported fields
}

type S3CredentialInfo struct {

	// S3 access key ID.
	AccessKeyId string `protobuf:"bytes,1,opt,name=access_key_id,json=accessKeyId,proto3" json:"access_key_id,omitempty"`
	// S3 access secret key.
	AccessSecretKey string `protobuf:"bytes,2,opt,name=access_secret_key,json=accessSecretKey,proto3" json:"access_secret_key,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedIdentityServer struct {
}

type UnimplementedProvisionerServer struct {
}

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

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