Documentation

Index

Constants

View Source
const (
	Default_TargetsDef_ExcludeLameducks = bool(true)
)

    Default values for TargetsDef fields.

    Variables

    View Source
    var File_github_com_google_cloudprober_targets_proto_targets_proto protoreflect.FileDescriptor

    Functions

    This section is empty.

    Types

    type DummyTargets

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

      DummyTargets represent empty targets, which are useful for external probes that do not have any "proper" targets. Such as ilbprober.

      func (*DummyTargets) Descriptor

      func (*DummyTargets) Descriptor() ([]byte, []int)

        Deprecated: Use DummyTargets.ProtoReflect.Descriptor instead.

        func (*DummyTargets) ProtoMessage

        func (*DummyTargets) ProtoMessage()

        func (*DummyTargets) ProtoReflect

        func (x *DummyTargets) ProtoReflect() protoreflect.Message

        func (*DummyTargets) Reset

        func (x *DummyTargets) Reset()

        func (*DummyTargets) String

        func (x *DummyTargets) String() string

        type GlobalTargetsOptions

        type GlobalTargetsOptions struct {
        
        	// RDS server address
        	// Deprecated: This option is now deprecated, please use rds_server_options
        	// instead.
        	//
        	// Deprecated: Do not use.
        	RdsServerAddress *string `protobuf:"bytes,3,opt,name=rds_server_address,json=rdsServerAddress" json:"rds_server_address,omitempty"`
        	// RDS server options, for example:
        	// rds_server_options {
        	//   server_address: "rds-server.xyz:9314"
        	//   oauth_config: {
        	//     ...
        	//   }
        	// }
        	RdsServerOptions *proto1.ClientConf_ServerOptions `protobuf:"bytes,4,opt,name=rds_server_options,json=rdsServerOptions" json:"rds_server_options,omitempty"`
        	// GCE targets options.
        	GlobalGceTargetsOptions *proto3.GlobalOptions `` /* 127-byte string literal not displayed */
        	// Lame duck options. If provided, targets module checks for the lame duck
        	// targets and removes them from the targets list.
        	LameDuckOptions *proto5.Options `protobuf:"bytes,2,opt,name=lame_duck_options,json=lameDuckOptions" json:"lame_duck_options,omitempty"`
        	// contains filtered or unexported fields
        }

          Global targets options. These options are independent of the per-probe targets which are defined by the "Targets" type above.

          Currently these options are used only for GCE targets to control things like how often to re-evaluate the targets and whether to check for lame ducks or not.

          func (*GlobalTargetsOptions) Descriptor

          func (*GlobalTargetsOptions) Descriptor() ([]byte, []int)

            Deprecated: Use GlobalTargetsOptions.ProtoReflect.Descriptor instead.

            func (*GlobalTargetsOptions) GetGlobalGceTargetsOptions

            func (x *GlobalTargetsOptions) GetGlobalGceTargetsOptions() *proto3.GlobalOptions

            func (*GlobalTargetsOptions) GetLameDuckOptions

            func (x *GlobalTargetsOptions) GetLameDuckOptions() *proto5.Options

            func (*GlobalTargetsOptions) GetRdsServerAddress

            func (x *GlobalTargetsOptions) GetRdsServerAddress() string

              Deprecated: Do not use.

              func (*GlobalTargetsOptions) GetRdsServerOptions

              func (x *GlobalTargetsOptions) GetRdsServerOptions() *proto1.ClientConf_ServerOptions

              func (*GlobalTargetsOptions) ProtoMessage

              func (*GlobalTargetsOptions) ProtoMessage()

              func (*GlobalTargetsOptions) ProtoReflect

              func (x *GlobalTargetsOptions) ProtoReflect() protoreflect.Message

              func (*GlobalTargetsOptions) Reset

              func (x *GlobalTargetsOptions) Reset()

              func (*GlobalTargetsOptions) String

              func (x *GlobalTargetsOptions) String() string

              type RDSTargets

              type RDSTargets struct {
              
              	// RDS server options, for example:
              	// rds_server_options {
              	//   server_address: "rds-server.xyz:9314"
              	//   oauth_config: {
              	//     ...
              	//   }
              	// }
              	RdsServerOptions *proto1.ClientConf_ServerOptions `protobuf:"bytes,1,opt,name=rds_server_options,json=rdsServerOptions" json:"rds_server_options,omitempty"`
              	// Resource path specifies the resources to return. Resources paths have the
              	// following format:
              	// <resource_provider>://<resource_type>/<additional_params>
              	//
              	// Examples:
              	// For GCE instances in projectA: "gcp://gce_instances/<projectA>"
              	// Kubernetes Pods : "k8s://pods"
              	ResourcePath *string `protobuf:"bytes,2,opt,name=resource_path,json=resourcePath" json:"resource_path,omitempty"`
              	// Filters to filter resources by.
              	Filter []*proto2.Filter `protobuf:"bytes,3,rep,name=filter" json:"filter,omitempty"`
              	// IP config to specify the IP address to pick for a resource.
              	IpConfig *proto2.IPConfig `protobuf:"bytes,4,opt,name=ip_config,json=ipConfig" json:"ip_config,omitempty"`
              	// contains filtered or unexported fields
              }

              func (*RDSTargets) Descriptor

              func (*RDSTargets) Descriptor() ([]byte, []int)

                Deprecated: Use RDSTargets.ProtoReflect.Descriptor instead.

                func (*RDSTargets) GetFilter

                func (x *RDSTargets) GetFilter() []*proto2.Filter

                func (*RDSTargets) GetIpConfig

                func (x *RDSTargets) GetIpConfig() *proto2.IPConfig

                func (*RDSTargets) GetRdsServerOptions

                func (x *RDSTargets) GetRdsServerOptions() *proto1.ClientConf_ServerOptions

                func (*RDSTargets) GetResourcePath

                func (x *RDSTargets) GetResourcePath() string

                func (*RDSTargets) ProtoMessage

                func (*RDSTargets) ProtoMessage()

                func (*RDSTargets) ProtoReflect

                func (x *RDSTargets) ProtoReflect() protoreflect.Message

                func (*RDSTargets) Reset

                func (x *RDSTargets) Reset()

                func (*RDSTargets) String

                func (x *RDSTargets) String() string

                type TargetsDef

                type TargetsDef struct {
                
                	// Types that are assignable to Type:
                	//	*TargetsDef_HostNames
                	//	*TargetsDef_SharedTargets
                	//	*TargetsDef_GceTargets
                	//	*TargetsDef_RdsTargets
                	//	*TargetsDef_FileTargets
                	//	*TargetsDef_DummyTargets
                	Type isTargetsDef_Type `protobuf_oneof:"type"`
                	// Regex to apply on the targets.
                	Regex *string `protobuf:"bytes,21,opt,name=regex" json:"regex,omitempty"`
                	// Exclude lameducks. Lameduck targets can be set through RTC (realtime
                	// configurator) service. This functionality works only if lame_duck_options
                	// are specified.
                	ExcludeLameducks *bool `protobuf:"varint,22,opt,name=exclude_lameducks,json=excludeLameducks,def=1" json:"exclude_lameducks,omitempty"`
                	// contains filtered or unexported fields
                }

                func (*TargetsDef) Descriptor

                func (*TargetsDef) Descriptor() ([]byte, []int)

                  Deprecated: Use TargetsDef.ProtoReflect.Descriptor instead.

                  func (*TargetsDef) ExtensionRangeArray

                  func (*TargetsDef) ExtensionRangeArray() []protoiface.ExtensionRangeV1

                    Deprecated: Use TargetsDef.ProtoReflect.Descriptor.ExtensionRanges instead.

                    func (*TargetsDef) GetDummyTargets

                    func (x *TargetsDef) GetDummyTargets() *DummyTargets

                    func (*TargetsDef) GetExcludeLameducks

                    func (x *TargetsDef) GetExcludeLameducks() bool

                    func (*TargetsDef) GetFileTargets

                    func (x *TargetsDef) GetFileTargets() *proto4.TargetsConf

                    func (*TargetsDef) GetGceTargets

                    func (x *TargetsDef) GetGceTargets() *proto3.TargetsConf

                    func (*TargetsDef) GetHostNames

                    func (x *TargetsDef) GetHostNames() string

                    func (*TargetsDef) GetRdsTargets

                    func (x *TargetsDef) GetRdsTargets() *RDSTargets

                    func (*TargetsDef) GetRegex

                    func (x *TargetsDef) GetRegex() string

                    func (*TargetsDef) GetSharedTargets

                    func (x *TargetsDef) GetSharedTargets() string

                    func (*TargetsDef) GetType

                    func (m *TargetsDef) GetType() isTargetsDef_Type

                    func (*TargetsDef) ProtoMessage

                    func (*TargetsDef) ProtoMessage()

                    func (*TargetsDef) ProtoReflect

                    func (x *TargetsDef) ProtoReflect() protoreflect.Message

                    func (*TargetsDef) Reset

                    func (x *TargetsDef) Reset()

                    func (*TargetsDef) String

                    func (x *TargetsDef) String() string

                    type TargetsDef_DummyTargets

                    type TargetsDef_DummyTargets struct {
                    	// Empty targets to meet the probe definition requirement where there are
                    	// actually no targets, for example in case of some external probes.
                    	DummyTargets *DummyTargets `protobuf:"bytes,20,opt,name=dummy_targets,json=dummyTargets,oneof"`
                    }

                    type TargetsDef_FileTargets

                    type TargetsDef_FileTargets struct {
                    	// File based targets.
                    	// Example:
                    	// file_targets {
                    	//   file_path: "/var/run/cloudprober/vips.textpb"
                    	// }
                    	FileTargets *proto4.TargetsConf `protobuf:"bytes,4,opt,name=file_targets,json=fileTargets,oneof"`
                    }

                    type TargetsDef_GceTargets

                    type TargetsDef_GceTargets struct {
                    	// GCE targets: instances and forwarding_rules, for example:
                    	// gce_targets {
                    	//   instances {}
                    	// }
                    	GceTargets *proto3.TargetsConf `protobuf:"bytes,2,opt,name=gce_targets,json=gceTargets,oneof"`
                    }

                    type TargetsDef_HostNames

                    type TargetsDef_HostNames struct {
                    	// Static host names, for example:
                    	// host_name: "www.google.com,8.8.8.8,en.wikipedia.org"
                    	HostNames string `protobuf:"bytes,1,opt,name=host_names,json=hostNames,oneof"`
                    }

                    type TargetsDef_RdsTargets

                    type TargetsDef_RdsTargets struct {
                    	// ResourceDiscovery service based targets.
                    	// Example:
                    	// rds_targets {
                    	//   resource_path: "gcp://gce_instances/{{.project}}"
                    	//   filter {
                    	//     key: "name"
                    	//     value: ".*backend.*"
                    	//   }
                    	// }
                    	RdsTargets *RDSTargets `protobuf:"bytes,3,opt,name=rds_targets,json=rdsTargets,oneof"`
                    }

                    type TargetsDef_SharedTargets

                    type TargetsDef_SharedTargets struct {
                    	// Shared targets are accessed through their names.
                    	// Example:
                    	// shared_targets {
                    	//   name:"backend-vms"
                    	//   targets {
                    	//     rds_targets {
                    	//       ..
                    	//     }
                    	//   }
                    	// }
                    	//
                    	// probe {
                    	//   targets {
                    	//     shared_targets: "backend-vms"
                    	//   }
                    	// }
                    	SharedTargets string `protobuf:"bytes,5,opt,name=shared_targets,json=sharedTargets,oneof"`
                    }

                    Source Files