objectstore

type AWSAccessKeyCredentialSchema struct {
	// AccessKeyID is the IAM access key ID
	AccessKeyID string `json:"accessKeyId" jsonschema:"required,title=Access Key ID"`
	// SecretAccessKey is the IAM secret access key
	SecretAccessKey string `json:"secretAccessKey" jsonschema:"required,title=Secret Access Key,secret=true"`
	// Region is the AWS region of the bucket
	Region string `json:"region" jsonschema:"required,title=Region,description=AWS region of the bucket (e.g. us-east-1)"`
	// BucketScope names the bucket the installation reads and writes
	BucketScope
}

type AWSAssumeRoleCredentialSchema struct {
	// RoleARN is the cross-account IAM role Openlane assumes in the customer account
	RoleARN string `` /* 131-byte string literal not displayed */
	// ExternalID is the external ID required in the role trust policy
	ExternalID string `` /* 149-byte string literal not displayed */
	// Region is the AWS region of the bucket
	Region string `json:"region" jsonschema:"required,title=Region,description=AWS region of the bucket (e.g. us-east-1)"`
	// SessionName is an optional STS session name override
	SessionName string `json:"sessionName,omitempty" jsonschema:"title=Session Name,description=Optional STS session name override"`
	// BucketScope names the bucket the installation reads and writes
	BucketScope
}

type BucketScope struct {
	// Bucket is the bucket the installation reads from and writes to
	Bucket string `json:"bucket" jsonschema:"required,title=Bucket,description=Bucket the integration reads from and writes to"`
}

type Client struct {
	// Provider is the storage provider scoped to the bucket
	Provider storage.Provider
	// Import is the prefix and kind the runtime import reads when the operation config leaves them empty, zero for installations
	Import ImportSpec
}

type Config struct {
	// AccessKeyID is the AWS access key ID for Openlane's source identity used when assuming customer roles
	AccessKeyID string `json:"accessKeyId" koanf:"accesskeyid" sensitive:"true"`
	// SecretAccessKey is the AWS secret access key for Openlane's source identity
	SecretAccessKey string `json:"secretAccessKey" koanf:"secretaccesskey" sensitive:"true"`
	// ARN is the Openlane principal customers allow in the trust policy of the role Openlane assumes
	ARN string `json:"arn" koanf:"arn"`
}

type ImportRecords struct {
	types.OperationSettings
	// ImportSpec selects the prefix to import
	ImportSpec
}

type ImportRecordsResult struct {
	operations.IngestResult
	// Objects is the number of JSON objects read under the prefix
	Objects int
	// Moved is the number of objects moved into the processed directory
	Moved int
}

type ImportSpec struct {
	// Prefix is the object key prefix whose JSON files hold arrays of records
	Prefix string `` /* 145-byte string literal not displayed */
	// MoveProcessed moves each object under the processed directory of the prefix once its records import without failure
	MoveProcessed bool `` /* 201-byte string literal not displayed */
}

type InstallationMetadata struct {
	// Provider is the storage provider holding the bucket
	Provider storage.ProviderType `json:"provider,omitempty" jsonschema:"title=Provider"`
	// Bucket is the bucket the installation is scoped to
	Bucket string `json:"bucket,omitempty" jsonschema:"title=Bucket"`
	// Region is the AWS region of the bucket when the provider is s3
	Region string `json:"region,omitempty" jsonschema:"title=Region"`
	// ProjectID is the Google Cloud project that owns the bucket when the provider is gcs
	ProjectID string `json:"projectId,omitempty" jsonschema:"title=Project ID"`
	// ServiceAccountEmail is the service account the installation acts as when available
	ServiceAccountEmail string `json:"serviceAccountEmail,omitempty" jsonschema:"title=Service Account Email"`
}

type R2CredentialSchema struct {
	// AccountID is the Cloudflare account that owns the bucket
	AccountID string `json:"accountId" jsonschema:"required,title=Account ID,description=Cloudflare account ID that owns the bucket"`
	// AccessKeyID is the R2 API token access key ID
	AccessKeyID string `json:"accessKeyId" jsonschema:"required,title=Access Key ID"`
	// SecretAccessKey is the R2 API token secret access key
	SecretAccessKey string `json:"secretAccessKey" jsonschema:"required,title=Secret Access Key,secret=true"`
	// BucketScope names the bucket the installation reads and writes
	BucketScope
}

type RuntimeConfig struct {
	// Providers holds the storage providers, exactly one enabled, holding the platform-owned bucket
	Providers storage.Providers `` /* 133-byte string literal not displayed */
	// Import selects the prefix and record kind the runtime import reads when the operation config leaves them empty
	Import ImportSpec `` /* 152-byte string literal not displayed */
}

type ServiceAccountCredentialSchema struct {
	// ServiceAccountKey is the service account key JSON used for direct credentials
	ServiceAccountKey string `` /* 182-byte string literal not displayed */
	// ProjectID is the Google Cloud project that owns the bucket
	ProjectID string `` /* 144-byte string literal not displayed */
	// BucketScope names the bucket the installation reads and writes
	BucketScope
}

type WorkloadIdentityCredentialSchema struct {
	// ProjectNumber is the numeric project number of the GCP project hosting the openlane workload identity pool and provider
	ProjectNumber string `` /* 195-byte string literal not displayed */
	// ServiceAccountEmail optionally impersonates a service account with access to the bucket
	ServiceAccountEmail string `` /* 155-byte string literal not displayed */
	// ProjectID is the Google Cloud project that owns the bucket
	ProjectID string `` /* 144-byte string literal not displayed */
	// BucketScope names the bucket the installation reads and writes
	BucketScope
}

type WriteObject struct {
	// Key is the object key to write the document under
	Key string `json:"key" jsonschema:"required,title=Key,description=Object key to write the document under"`
	// ContentType is the MIME type recorded for the object
	ContentType string `` /* 129-byte string literal not displayed */
	// Content is the document to write; a string is written verbatim and any other value is JSON encoded
	Content any `` /* 144-byte string literal not displayed */
}

type WriteObjectResult struct {
	// Bucket is the bucket the object was written to
	Bucket string `json:"bucket"`
	// Key is the object key the document was written under
	Key string `json:"key"`
	// ContentType is the MIME type recorded for the object
	ContentType string `json:"contentType"`
	// Size is the number of bytes written
	Size int64 `json:"size"`
	// URI is the provider URI of the written object
	URI string `json:"uri"`
}