Documentation
¶
Index ¶
- Constants
- Variables
- type ABS
- func (*ABS) Descriptor() ([]byte, []int)deprecated
- func (x *ABS) GetAccountKey() string
- func (x *ABS) GetAccountName() string
- func (x *ABS) GetContainer() string
- func (x *ABS) GetEndpoint() string
- func (x *ABS) GetOauthConfig() *proto.Config
- func (*ABS) ProtoMessage()
- func (x *ABS) ProtoReflect() protoreflect.Message
- func (x *ABS) Reset()
- func (x *ABS) String() string
- type ArtifactsOptions
- func (*ArtifactsOptions) Descriptor() ([]byte, []int)deprecated
- func (x *ArtifactsOptions) GetServeOnWeb() bool
- func (x *ArtifactsOptions) GetStorage() []*Storage
- func (x *ArtifactsOptions) GetWebServerPath() string
- func (x *ArtifactsOptions) GetWebServerRoot() string
- func (*ArtifactsOptions) ProtoMessage()
- func (x *ArtifactsOptions) ProtoReflect() protoreflect.Message
- func (x *ArtifactsOptions) Reset()
- func (x *ArtifactsOptions) String() string
- type CleanupOptions
- func (*CleanupOptions) Descriptor() ([]byte, []int)deprecated
- func (x *CleanupOptions) GetCleanupIntervalSec() int32
- func (x *CleanupOptions) GetMaxAgeSec() int32
- func (*CleanupOptions) ProtoMessage()
- func (x *CleanupOptions) ProtoReflect() protoreflect.Message
- func (x *CleanupOptions) Reset()
- func (x *CleanupOptions) String() string
- type GCS
- func (*GCS) Descriptor() ([]byte, []int)deprecated
- func (x *GCS) GetBucket() string
- func (x *GCS) GetCredentials() *proto.GoogleCredentials
- func (x *GCS) GetEndpoint() string
- func (*GCS) ProtoMessage()
- func (x *GCS) ProtoReflect() protoreflect.Message
- func (x *GCS) Reset()
- func (x *GCS) String() string
- type LocalStorage
- func (*LocalStorage) Descriptor() ([]byte, []int)deprecated
- func (x *LocalStorage) GetCleanupOptions() *CleanupOptions
- func (x *LocalStorage) GetDir() string
- func (*LocalStorage) ProtoMessage()
- func (x *LocalStorage) ProtoReflect() protoreflect.Message
- func (x *LocalStorage) Reset()
- func (x *LocalStorage) String() string
- type S3
- func (*S3) Descriptor() ([]byte, []int)deprecated
- func (x *S3) GetAccessKeyId() string
- func (x *S3) GetBucket() string
- func (x *S3) GetEndpoint() string
- func (x *S3) GetRegion() string
- func (x *S3) GetSecretAccessKey() string
- func (*S3) ProtoMessage()
- func (x *S3) ProtoReflect() protoreflect.Message
- func (x *S3) Reset()
- func (x *S3) String() string
- type Storage
- func (*Storage) Descriptor() ([]byte, []int)deprecated
- func (x *Storage) GetAbs() *ABS
- func (x *Storage) GetGcs() *GCS
- func (x *Storage) GetLocalStorage() *LocalStorage
- func (x *Storage) GetPath() string
- func (x *Storage) GetS3() *S3
- func (x *Storage) GetStorage() isStorage_Storage
- func (*Storage) ProtoMessage()
- func (x *Storage) ProtoReflect() protoreflect.Message
- func (x *Storage) Reset()
- func (x *Storage) String() string
- type Storage_Abs
- type Storage_Gcs
- type Storage_LocalStorage
- type Storage_S3
Constants ¶
View Source
const ( Default_CleanupOptions_MaxAgeSec = int32(3600) Default_CleanupOptions_CleanupIntervalSec = int32(3600) )
Default values for CleanupOptions fields.
View Source
const (
Default_GCS_Endpoint = string("https://storage.googleapis.com")
)
Default values for GCS fields.
Variables ¶
View Source
var File_github_com_cloudprober_cloudprober_probes_browser_artifacts_proto_config_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ABS ¶
type ABS struct { Container *string `protobuf:"bytes,1,opt,name=container" json:"container,omitempty"` // Azure account name and key. If you want to use managed identities, leave // account_key empty. AccountName *string `protobuf:"bytes,2,opt,name=account_name,json=accountName" json:"account_name,omitempty"` AccountKey *string `protobuf:"bytes,3,opt,name=account_key,json=accountKey" json:"account_key,omitempty"` // Azure endpoint. Default is "https://<account>.blob.core.windows.net". Endpoint *string `protobuf:"bytes,4,opt,name=endpoint" json:"endpoint,omitempty"` // OAuth2 configuration. If you want to use managed identities, leave this // field empty. See // https://cloudprober.org/docs/config/latest/oauth/#cloudprober_oauth_Config // for more details on oauth.Config. OauthConfig *proto.Config `protobuf:"bytes,5,opt,name=oauth_config,json=oauthConfig" json:"oauth_config,omitempty"` // contains filtered or unexported fields }
func (*ABS) Descriptor
deprecated
func (*ABS) GetAccountKey ¶
func (*ABS) GetAccountName ¶
func (*ABS) GetContainer ¶
func (*ABS) GetEndpoint ¶
func (*ABS) GetOauthConfig ¶
func (*ABS) ProtoMessage ¶
func (*ABS) ProtoMessage()
func (*ABS) ProtoReflect ¶
func (x *ABS) ProtoReflect() protoreflect.Message
type ArtifactsOptions ¶
type ArtifactsOptions struct { // Serve test artifacts on Cloudprober's default webserver. This is // disabled by default for security reasons. ServeOnWeb *bool `protobuf:"varint,1,opt,name=serve_on_web,json=serveOnWeb" json:"serve_on_web,omitempty"` // Specify web server path to serve test artifacts on. // Default is "/artifacts/<probename>". WebServerPath *string `protobuf:"bytes,2,opt,name=web_server_path,json=webServerPath" json:"web_server_path,omitempty"` // Web server root directory. If not provided (recommended), we just use // the first local storage directory if configured, and if provided, we // verify that it is one of the local storages directories. If no local // storage is configured, we return an error for global options and use // <workdir>/output for probe level artifacts options. WebServerRoot *string `protobuf:"bytes,4,opt,name=web_server_root,json=webServerRoot" json:"web_server_root,omitempty"` // Storage for test artifacts. Note that test artifacts are always // written to the workdir first, and uploaded to the storage backend in a // parallel goroutine. This is to make sure that uploads don't block the // main probe execution. Storage []*Storage `protobuf:"bytes,3,rep,name=storage" json:"storage,omitempty"` // contains filtered or unexported fields }
func (*ArtifactsOptions) Descriptor
deprecated
func (*ArtifactsOptions) Descriptor() ([]byte, []int)
Deprecated: Use ArtifactsOptions.ProtoReflect.Descriptor instead.
func (*ArtifactsOptions) GetServeOnWeb ¶
func (x *ArtifactsOptions) GetServeOnWeb() bool
func (*ArtifactsOptions) GetStorage ¶
func (x *ArtifactsOptions) GetStorage() []*Storage
func (*ArtifactsOptions) GetWebServerPath ¶
func (x *ArtifactsOptions) GetWebServerPath() string
func (*ArtifactsOptions) GetWebServerRoot ¶
func (x *ArtifactsOptions) GetWebServerRoot() string
func (*ArtifactsOptions) ProtoMessage ¶
func (*ArtifactsOptions) ProtoMessage()
func (*ArtifactsOptions) ProtoReflect ¶
func (x *ArtifactsOptions) ProtoReflect() protoreflect.Message
func (*ArtifactsOptions) Reset ¶
func (x *ArtifactsOptions) Reset()
func (*ArtifactsOptions) String ¶
func (x *ArtifactsOptions) String() string
type CleanupOptions ¶
type CleanupOptions struct { // Maximum age of artifacts in seconds. MaxAgeSec *int32 `protobuf:"varint,1,opt,name=max_age_sec,json=maxAgeSec,def=3600" json:"max_age_sec,omitempty"` // Cleanup interval in seconds. Default is 1 hour or max_age_sec, whichever // is smaller. CleanupIntervalSec *int32 `protobuf:"varint,3,opt,name=cleanup_interval_sec,json=cleanupIntervalSec,def=3600" json:"cleanup_interval_sec,omitempty"` // contains filtered or unexported fields }
func (*CleanupOptions) Descriptor
deprecated
func (*CleanupOptions) Descriptor() ([]byte, []int)
Deprecated: Use CleanupOptions.ProtoReflect.Descriptor instead.
func (*CleanupOptions) GetCleanupIntervalSec ¶
func (x *CleanupOptions) GetCleanupIntervalSec() int32
func (*CleanupOptions) GetMaxAgeSec ¶
func (x *CleanupOptions) GetMaxAgeSec() int32
func (*CleanupOptions) ProtoMessage ¶
func (*CleanupOptions) ProtoMessage()
func (*CleanupOptions) ProtoReflect ¶
func (x *CleanupOptions) ProtoReflect() protoreflect.Message
func (*CleanupOptions) Reset ¶
func (x *CleanupOptions) Reset()
func (*CleanupOptions) String ¶
func (x *CleanupOptions) String() string
type GCS ¶
type GCS struct { Bucket *string `protobuf:"bytes,1,opt,name=bucket" json:"bucket,omitempty"` // If you want to use default credentials on GCE or GKE, leave this field // empty. See // https://cloudprober.org/docs/config/latest/oauth/#cloudprober_oauth_GoogleCredentials // for more details on oauth.GoogleCredentials. Credentials *proto.GoogleCredentials `protobuf:"bytes,2,opt,name=credentials" json:"credentials,omitempty"` // GCS endpoint. Endpoint *string `protobuf:"bytes,3,opt,name=endpoint,def=https://storage.googleapis.com" json:"endpoint,omitempty"` // contains filtered or unexported fields }
func (*GCS) Descriptor
deprecated
func (*GCS) GetCredentials ¶
func (x *GCS) GetCredentials() *proto.GoogleCredentials
func (*GCS) GetEndpoint ¶
func (*GCS) ProtoMessage ¶
func (*GCS) ProtoMessage()
func (*GCS) ProtoReflect ¶
func (x *GCS) ProtoReflect() protoreflect.Message
type LocalStorage ¶
type LocalStorage struct { Dir *string `protobuf:"bytes,1,opt,name=dir" json:"dir,omitempty"` // Cleanup options for local storage. Specifying cleanup options for local // enables automatic cleanup of old artifacts. CleanupOptions *CleanupOptions `protobuf:"bytes,2,opt,name=cleanup_options,json=cleanupOptions" json:"cleanup_options,omitempty"` // contains filtered or unexported fields }
func (*LocalStorage) Descriptor
deprecated
func (*LocalStorage) Descriptor() ([]byte, []int)
Deprecated: Use LocalStorage.ProtoReflect.Descriptor instead.
func (*LocalStorage) GetCleanupOptions ¶
func (x *LocalStorage) GetCleanupOptions() *CleanupOptions
func (*LocalStorage) GetDir ¶
func (x *LocalStorage) GetDir() string
func (*LocalStorage) ProtoMessage ¶
func (*LocalStorage) ProtoMessage()
func (*LocalStorage) ProtoReflect ¶
func (x *LocalStorage) ProtoReflect() protoreflect.Message
func (*LocalStorage) Reset ¶
func (x *LocalStorage) Reset()
func (*LocalStorage) String ¶
func (x *LocalStorage) String() string
type S3 ¶
type S3 struct { Bucket *string `protobuf:"bytes,1,opt,name=bucket" json:"bucket,omitempty"` Region *string `protobuf:"bytes,2,opt,name=region" json:"region,omitempty"` AccessKeyId *string `protobuf:"bytes,3,opt,name=access_key_id,json=accessKeyId" json:"access_key_id,omitempty"` SecretAccessKey *string `protobuf:"bytes,4,opt,name=secret_access_key,json=secretAccessKey" json:"secret_access_key,omitempty"` // S3 endpoint. If not specified, default endpoint for the region is used. Endpoint *string `protobuf:"bytes,5,opt,name=endpoint" json:"endpoint,omitempty"` // contains filtered or unexported fields }
S3 storage backend configuration.
func (*S3) Descriptor
deprecated
func (*S3) GetAccessKeyId ¶
func (*S3) GetEndpoint ¶
func (*S3) GetSecretAccessKey ¶
func (*S3) ProtoMessage ¶
func (*S3) ProtoMessage()
func (*S3) ProtoReflect ¶
func (x *S3) ProtoReflect() protoreflect.Message
type Storage ¶
type Storage struct { // Types that are valid to be assigned to Storage: // // *Storage_LocalStorage // *Storage_S3 // *Storage_Gcs // *Storage_Abs Storage isStorage_Storage `protobuf_oneof:"storage"` // Storage path for test artifacts. This is the path where test artifacts // are written to within the storage backend. For example, if storage is // an S3 bucket, all objects will be uploaded under this path within that // bucket. For global artifacts options, probes append their names to this // path. Path *string `protobuf:"bytes,90,opt,name=path" json:"path,omitempty"` // contains filtered or unexported fields }
func (*Storage) Descriptor
deprecated
func (*Storage) GetLocalStorage ¶
func (x *Storage) GetLocalStorage() *LocalStorage
func (*Storage) GetStorage ¶
func (x *Storage) GetStorage() isStorage_Storage
func (*Storage) ProtoMessage ¶
func (*Storage) ProtoMessage()
func (*Storage) ProtoReflect ¶
func (x *Storage) ProtoReflect() protoreflect.Message
type Storage_Abs ¶
type Storage_Abs struct {
Abs *ABS `protobuf:"bytes,4,opt,name=abs,oneof"`
}
type Storage_Gcs ¶
type Storage_Gcs struct {
Gcs *GCS `protobuf:"bytes,3,opt,name=gcs,oneof"`
}
type Storage_LocalStorage ¶
type Storage_LocalStorage struct {
LocalStorage *LocalStorage `protobuf:"bytes,1,opt,name=local_storage,json=localStorage,oneof"`
}
type Storage_S3 ¶
type Storage_S3 struct {
S3 *S3 `protobuf:"bytes,2,opt,name=s3,oneof"`
}
Click to show internal directories.
Click to hide internal directories.