Documentation ¶
Index ¶
- Variables
- type Certificate
- func (*Certificate) Descriptor() ([]byte, []int)deprecated
- func (x *Certificate) GetId() string
- func (x *Certificate) GetNotAfterTime() *timestamppb.Timestamp
- func (x *Certificate) GetNotBeforeTime() *timestamppb.Timestamp
- func (x *Certificate) GetPublicKeySha256() string
- func (*Certificate) ProtoMessage()
- func (x *Certificate) ProtoReflect() protoreflect.Message
- func (x *Certificate) Reset()
- func (x *Certificate) String() string
- type CertificateAuthority
- func (*CertificateAuthority) Descriptor() ([]byte, []int)deprecated
- func (x *CertificateAuthority) GetCerts() []*Certificate
- func (*CertificateAuthority) ProtoMessage()
- func (x *CertificateAuthority) ProtoReflect() protoreflect.Message
- func (x *CertificateAuthority) Reset()
- func (x *CertificateAuthority) String() string
- type RemoteStoragePermissions
- func (*RemoteStoragePermissions) Descriptor() ([]byte, []int)deprecated
- func (x *RemoteStoragePermissions) GetDelete() string
- func (x *RemoteStoragePermissions) GetRead() string
- func (x *RemoteStoragePermissions) GetWrite() string
- func (*RemoteStoragePermissions) ProtoMessage()
- func (x *RemoteStoragePermissions) ProtoReflect() protoreflect.Message
- func (x *RemoteStoragePermissions) Reset()
- func (x *RemoteStoragePermissions) String() string
- type RemoteStorageState
- func (*RemoteStorageState) Descriptor() ([]byte, []int)deprecated
- func (x *RemoteStorageState) GetPermissions() *RemoteStoragePermissions
- func (x *RemoteStorageState) GetStatus() string
- func (*RemoteStorageState) ProtoMessage()
- func (x *RemoteStorageState) ProtoReflect() protoreflect.Message
- func (x *RemoteStorageState) Reset()
- func (x *RemoteStorageState) String() string
- type Worker
- func (*Worker) Descriptor() ([]byte, []int)deprecated
- func (x *Worker) GetActiveConnectionCount() *wrapperspb.UInt32Value
- func (x *Worker) GetAddress() string
- func (x *Worker) GetApiTags() map[string]*structpb.ListValue
- func (x *Worker) GetAuthorizedActions() []string
- func (x *Worker) GetCanonicalTags() map[string]*structpb.ListValue
- func (x *Worker) GetConfigTags() map[string]*structpb.ListValue
- func (x *Worker) GetControllerGeneratedActivationToken() *wrapperspb.StringValue
- func (x *Worker) GetCreatedTime() *timestamppb.Timestamp
- func (x *Worker) GetDescription() *wrapperspb.StringValue
- func (x *Worker) GetDirectlyConnectedDownstreamWorkers() []string
- func (x *Worker) GetId() string
- func (x *Worker) GetLastStatusTime() *timestamppb.Timestamp
- func (x *Worker) GetLocalStorageState() string
- func (x *Worker) GetName() *wrapperspb.StringValue
- func (x *Worker) GetReleaseVersion() string
- func (x *Worker) GetRemoteStorageState() map[string]*RemoteStorageState
- func (x *Worker) GetScope() *scopes.ScopeInfo
- func (x *Worker) GetScopeId() string
- func (x *Worker) GetType() string
- func (x *Worker) GetUpdatedTime() *timestamppb.Timestamp
- func (x *Worker) GetVersion() uint32
- func (x *Worker) GetWorkerGeneratedAuthToken() *wrapperspb.StringValue
- func (*Worker) ProtoMessage()
- func (x *Worker) ProtoReflect() protoreflect.Message
- func (x *Worker) Reset()
- func (x *Worker) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_controller_api_resources_workers_v1_worker_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Certificate ¶ added in v0.0.23
type Certificate struct { // Output only. The ID of the certificate Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The public key of the cert authority PublicKeySha256 string `protobuf:"bytes,20,opt,name=public_key_sha256,json=publicKeySha256,proto3" json:"public_key_sha256,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The time before which this CA is invalid NotBeforeTime *timestamppb.Timestamp `protobuf:"bytes,30,opt,name=not_before_time,json=notBeforeTime,proto3" json:"not_before_time,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The time after which this CA is invalid NotAfterTime *timestamppb.Timestamp `protobuf:"bytes,40,opt,name=not_after_time,json=notAfterTime,proto3" json:"not_after_time,omitempty" class:"public"` // @gotags: `class:"public"` // contains filtered or unexported fields }
func (*Certificate) Descriptor
deprecated
added in
v0.0.23
func (*Certificate) Descriptor() ([]byte, []int)
Deprecated: Use Certificate.ProtoReflect.Descriptor instead.
func (*Certificate) GetId ¶ added in v0.0.23
func (x *Certificate) GetId() string
func (*Certificate) GetNotAfterTime ¶ added in v0.0.23
func (x *Certificate) GetNotAfterTime() *timestamppb.Timestamp
func (*Certificate) GetNotBeforeTime ¶ added in v0.0.23
func (x *Certificate) GetNotBeforeTime() *timestamppb.Timestamp
func (*Certificate) GetPublicKeySha256 ¶ added in v0.0.23
func (x *Certificate) GetPublicKeySha256() string
func (*Certificate) ProtoMessage ¶ added in v0.0.23
func (*Certificate) ProtoMessage()
func (*Certificate) ProtoReflect ¶ added in v0.0.23
func (x *Certificate) ProtoReflect() protoreflect.Message
func (*Certificate) Reset ¶ added in v0.0.23
func (x *Certificate) Reset()
func (*Certificate) String ¶ added in v0.0.23
func (x *Certificate) String() string
type CertificateAuthority ¶ added in v0.0.23
type CertificateAuthority struct { Certs []*Certificate `protobuf:"bytes,10,rep,name=certs,proto3" json:"certs,omitempty" class:"public"` // @gotags: `class:"public"` // contains filtered or unexported fields }
func (*CertificateAuthority) Descriptor
deprecated
added in
v0.0.23
func (*CertificateAuthority) Descriptor() ([]byte, []int)
Deprecated: Use CertificateAuthority.ProtoReflect.Descriptor instead.
func (*CertificateAuthority) GetCerts ¶ added in v0.0.23
func (x *CertificateAuthority) GetCerts() []*Certificate
func (*CertificateAuthority) ProtoMessage ¶ added in v0.0.23
func (*CertificateAuthority) ProtoMessage()
func (*CertificateAuthority) ProtoReflect ¶ added in v0.0.23
func (x *CertificateAuthority) ProtoReflect() protoreflect.Message
func (*CertificateAuthority) Reset ¶ added in v0.0.23
func (x *CertificateAuthority) Reset()
func (*CertificateAuthority) String ¶ added in v0.0.23
func (x *CertificateAuthority) String() string
type RemoteStoragePermissions ¶ added in v0.0.48
type RemoteStoragePermissions struct { // Output only. The status of the write permission state for the given storage bucket. // Possible values are: unknown, error, and ok. Write string `protobuf:"bytes,10,opt,name=write,proto3" json:"write,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The status of the read permission state for the given storage bucket. // Possible values are: unknown, error, and ok. Read string `protobuf:"bytes,20,opt,name=read,proto3" json:"read,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The status of the delete permission state for the given storage bucket. // Possible values are: unknown, error, and ok. Delete string `protobuf:"bytes,30,opt,name=delete,proto3" json:"delete,omitempty" class:"public"` // @gotags: `class:"public"` // contains filtered or unexported fields }
func (*RemoteStoragePermissions) Descriptor
deprecated
added in
v0.0.48
func (*RemoteStoragePermissions) Descriptor() ([]byte, []int)
Deprecated: Use RemoteStoragePermissions.ProtoReflect.Descriptor instead.
func (*RemoteStoragePermissions) GetDelete ¶ added in v0.0.48
func (x *RemoteStoragePermissions) GetDelete() string
func (*RemoteStoragePermissions) GetRead ¶ added in v0.0.48
func (x *RemoteStoragePermissions) GetRead() string
func (*RemoteStoragePermissions) GetWrite ¶ added in v0.0.48
func (x *RemoteStoragePermissions) GetWrite() string
func (*RemoteStoragePermissions) ProtoMessage ¶ added in v0.0.48
func (*RemoteStoragePermissions) ProtoMessage()
func (*RemoteStoragePermissions) ProtoReflect ¶ added in v0.0.48
func (x *RemoteStoragePermissions) ProtoReflect() protoreflect.Message
func (*RemoteStoragePermissions) Reset ¶ added in v0.0.48
func (x *RemoteStoragePermissions) Reset()
func (*RemoteStoragePermissions) String ¶ added in v0.0.48
func (x *RemoteStoragePermissions) String() string
type RemoteStorageState ¶ added in v0.0.48
type RemoteStorageState struct { // Output only. The overall health status of the storage bucket. The possible values include: error and available. // The status exists in an available state if each remote storage permission state does not have an error. An unknown remote // storage permission state does not affect the overall health status. Status string `protobuf:"bytes,10,opt,name=status,proto3" json:"status,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The remote storage permissions contains the permission state for each individual permission type. Permissions *RemoteStoragePermissions `protobuf:"bytes,20,opt,name=permissions,proto3" json:"permissions,omitempty" class:"public"` // @gotags: `class:"public"` // contains filtered or unexported fields }
func (*RemoteStorageState) Descriptor
deprecated
added in
v0.0.48
func (*RemoteStorageState) Descriptor() ([]byte, []int)
Deprecated: Use RemoteStorageState.ProtoReflect.Descriptor instead.
func (*RemoteStorageState) GetPermissions ¶ added in v0.0.48
func (x *RemoteStorageState) GetPermissions() *RemoteStoragePermissions
func (*RemoteStorageState) GetStatus ¶ added in v0.0.48
func (x *RemoteStorageState) GetStatus() string
func (*RemoteStorageState) ProtoMessage ¶ added in v0.0.48
func (*RemoteStorageState) ProtoMessage()
func (*RemoteStorageState) ProtoReflect ¶ added in v0.0.48
func (x *RemoteStorageState) ProtoReflect() protoreflect.Message
func (*RemoteStorageState) Reset ¶ added in v0.0.48
func (x *RemoteStorageState) Reset()
func (*RemoteStorageState) String ¶ added in v0.0.48
func (x *RemoteStorageState) String() string
type Worker ¶
type Worker struct { // Output only. The ID of the User. Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"` // The ID of the Scope this resource is in. ScopeId string `protobuf:"bytes,20,opt,name=scope_id,proto3" json:"scope_id,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"` // Output only. Scope information for this resource. Scope *scopes.ScopeInfo `protobuf:"bytes,30,opt,name=scope,proto3" json:"scope,omitempty"` // Optional name for identification purposes. Can only be set through the API // for `pki`-type workers; read-only for `kms`-type workers. Name *wrapperspb.StringValue `protobuf:"bytes,40,opt,name=name,proto3" json:"name,omitempty" class:"sensitive"` // @gotags: `class:"sensitive"` // Optional user-set description for identification purposes. Can only be set // through the API for `pki`-type workers; read-only for `kms`-type workers. Description *wrapperspb.StringValue `protobuf:"bytes,50,opt,name=description,proto3" json:"description,omitempty" class:"sensitive"` // @gotags: `class:"sensitive"` // Output only. The time this resource was created. CreatedTime *timestamppb.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"` // Output only. The time this resource was last updated. UpdatedTime *timestamppb.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty" class:"public" eventstream:"observation"` // @gotags: `class:"public" eventstream:"observation"` // Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. // The mutation will fail if the version does not match the latest known good version. Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The address that this worker is reachable at, as sourced from // the worker's configuration file. Address string `protobuf:"bytes,90,opt,name=address,proto3" json:"address,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The deduplicated union of the tags reported by the worker from // its configuration and any tags added through other means. This is used // when applying worker filters. CanonicalTags map[string]*structpb.ListValue `` // @gotags: `class:"public"` /* 186-byte string literal not displayed */ // Output only. The tags set in the worker's configuration file. ConfigTags map[string]*structpb.ListValue `` // @gotags: `class:"public"` /* 180-byte string literal not displayed */ // Output only. The time this worker daemon last reported its status. LastStatusTime *timestamppb.Timestamp `` // @gotags: `class:"public" eventstream:"observation"` /* 128-byte string literal not displayed */ // worker_generated_auth_token is input only. Supports the worker led node // enrollment flow where this credentials token is produced by a worker. This // token is a base58 encoded types.FetchNodeCredentialsRequest from // https://github.com/hashicorp/nodeenrollment WorkerGeneratedAuthToken *wrapperspb.StringValue `protobuf:"bytes,150,opt,name=worker_generated_auth_token,proto3" json:"worker_generated_auth_token,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. An activation token that can be given to a worker to correlate // it to the created resource. ControllerGeneratedActivationToken *wrapperspb.StringValue `` // @gotags: `class:"secret"` /* 144-byte string literal not displayed */ // Output only. The number of connections that this worker is currently handling. ActiveConnectionCount *wrapperspb.UInt32Value `` // @gotags: `class:"public" eventstream:"observation"` /* 142-byte string literal not displayed */ // Output only. The type of the worker, denoted by how it authenticates: `pki` // or `kms`. Type string `protobuf:"bytes,170,opt,name=type,proto3" json:"type,omitempty"` // Output only. The api tags set for the worker. ApiTags map[string]*structpb.ListValue `` // @gotags: `class:"public"` /* 174-byte string literal not displayed */ // Output only. The version of the Boundary binary the worker is running. ReleaseVersion string `` // @gotags: `class:"public" eventstream:"observation"` /* 126-byte string literal not displayed */ // Output only. The ids of the workers directly connected to this worker. DirectlyConnectedDownstreamWorkers []string `` // @gotags: `class:"public" eventstream:"observation"` /* 170-byte string literal not displayed */ // Output only. The available actions on this resource for the requester. AuthorizedActions []string `protobuf:"bytes,300,rep,name=authorized_actions,proto3" json:"authorized_actions,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The local_storage_state indicates the state of the local disk space of the worker. // Possible values are: // - available: The worker local storage state is at an acceptable state // - low storage: The worker is below the minimum threshold for local storage // - critically low storage: The worker local storage state is below the critical minimum threshold for local storage // - out of storage: The worker is out of local disk space // - not configured: The worker does not have a local storage path configured // - unknown: The default local storage state of a worker. Used when the local storage state of a worker is not yet known LocalStorageState string `protobuf:"bytes,310,opt,name=local_storage_state,proto3" json:"local_storage_state,omitempty" class:"public"` // @gotags: `class:"public"` // Output only. The remote_storage_state indicats the permission state of the storage buckets that the Worker // is actively using. The possible permission state types include: write, read, and delete. The possible // permission state values include: unknown, error, and ok. RemoteStorageState map[string]*RemoteStorageState `` // @gotags: `class:"public"` /* 198-byte string literal not displayed */ // contains filtered or unexported fields }
Worker contains all fields related to a Worker resource
func (*Worker) Descriptor
deprecated
func (*Worker) GetActiveConnectionCount ¶
func (x *Worker) GetActiveConnectionCount() *wrapperspb.UInt32Value
func (*Worker) GetAddress ¶
func (*Worker) GetApiTags ¶ added in v0.0.18
func (*Worker) GetAuthorizedActions ¶
func (*Worker) GetCanonicalTags ¶
func (*Worker) GetControllerGeneratedActivationToken ¶ added in v0.0.22
func (x *Worker) GetControllerGeneratedActivationToken() *wrapperspb.StringValue
func (*Worker) GetCreatedTime ¶
func (x *Worker) GetCreatedTime() *timestamppb.Timestamp
func (*Worker) GetDescription ¶
func (x *Worker) GetDescription() *wrapperspb.StringValue
func (*Worker) GetDirectlyConnectedDownstreamWorkers ¶ added in v0.0.29
func (*Worker) GetLastStatusTime ¶
func (x *Worker) GetLastStatusTime() *timestamppb.Timestamp
func (*Worker) GetLocalStorageState ¶ added in v0.0.46
func (*Worker) GetName ¶
func (x *Worker) GetName() *wrapperspb.StringValue
func (*Worker) GetReleaseVersion ¶ added in v0.0.23
func (*Worker) GetRemoteStorageState ¶ added in v0.0.48
func (x *Worker) GetRemoteStorageState() map[string]*RemoteStorageState
func (*Worker) GetScopeId ¶
func (*Worker) GetUpdatedTime ¶
func (x *Worker) GetUpdatedTime() *timestamppb.Timestamp
func (*Worker) GetVersion ¶
func (*Worker) GetWorkerGeneratedAuthToken ¶
func (x *Worker) GetWorkerGeneratedAuthToken() *wrapperspb.StringValue
func (*Worker) ProtoMessage ¶
func (*Worker) ProtoMessage()
func (*Worker) ProtoReflect ¶
func (x *Worker) ProtoReflect() protoreflect.Message
Click to show internal directories.
Click to hide internal directories.