trafficdirector
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package trafficdirector provides access to the Traffic Director API.
For product documentation, see:https://cloud.google.com/traffic-director
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/trafficdirector/v2"...ctx := context.Background()trafficdirectorService, err := trafficdirector.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
trafficdirectorService, err := trafficdirector.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)trafficdirectorService, err := trafficdirector.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type Address
- type BuildVersion
- type ClientConfig
- type ClientStatusRequest
- type ClientStatusResponse
- type ClustersConfigDump
- type DiscoveryClientStatusCall
- func (c *DiscoveryClientStatusCall) Context(ctx context.Context) *DiscoveryClientStatusCall
- func (c *DiscoveryClientStatusCall) Do(opts ...googleapi.CallOption) (*ClientStatusResponse, error)
- func (c *DiscoveryClientStatusCall) Fields(s ...googleapi.Field) *DiscoveryClientStatusCall
- func (c *DiscoveryClientStatusCall) Header() http.Header
- type DiscoveryService
- type DoubleMatcher
- type DoubleRange
- type DynamicCluster
- type DynamicListener
- type DynamicListenerState
- type DynamicRouteConfig
- type DynamicScopedRouteConfigs
- type Extension
- type GoogleRE2
- type InlineScopedRouteConfigs
- type ListMatcher
- type ListenersConfigDump
- type Locality
- type Node
- type NodeMatcher
- type NullMatch
- type PathSegment
- type PerXdsConfig
- type Pipe
- type RegexMatcher
- type RoutesConfigDump
- type ScopedRoutesConfigDump
- type SemanticVersion
- type Service
- type SocketAddress
- type StaticCluster
- type StaticListener
- type StaticRouteConfig
- type StringMatcher
- type StructMatcher
- type UpdateFailureState
- type ValueMatcher
Constants¶
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAddress¶
type Address struct {Pipe *Pipe `json:"pipe,omitempty"`SocketAddress *SocketAddress `json:"socketAddress,omitempty"`// ForceSendFields is a list of field names (e.g. "Pipe") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Pipe") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Address: Addresses specify either a logical or physical address and port,which are used to tell Envoy where to bind/listen, connect to upstream andfind management servers.
func (Address)MarshalJSON¶
typeBuildVersion¶
type BuildVersion struct {// Metadata: Free-form build information. Envoy defines several well known keys// in the source/common/version/version.h fileMetadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Version: SemVer version of extension.Version *SemanticVersion `json:"version,omitempty"`// ForceSendFields is a list of field names (e.g. "Metadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Metadata") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}BuildVersion: BuildVersion combines SemVer version of extension withfree-form build information (i.e. 'alpha', 'private-build') as a set ofstrings.
func (BuildVersion)MarshalJSON¶
func (sBuildVersion) MarshalJSON() ([]byte,error)
typeClientConfig¶
type ClientConfig struct {// Node: Node for a particular client.Node *Node `json:"node,omitempty"`XdsConfig []*PerXdsConfig `json:"xdsConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "Node") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Node") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ClientConfig: All xds configs for a particular client.
func (ClientConfig)MarshalJSON¶
func (sClientConfig) MarshalJSON() ([]byte,error)
typeClientStatusRequest¶
type ClientStatusRequest struct {// NodeMatchers: Management server can use these match criteria to identify// clients. The match follows OR semantics.NodeMatchers []*NodeMatcher `json:"nodeMatchers,omitempty"`// ForceSendFields is a list of field names (e.g. "NodeMatchers") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NodeMatchers") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ClientStatusRequest: Request for client status of clients identified by alist of NodeMatchers.
func (ClientStatusRequest)MarshalJSON¶
func (sClientStatusRequest) MarshalJSON() ([]byte,error)
typeClientStatusResponse¶
type ClientStatusResponse struct {// Config: Client configs for the clients specified in the ClientStatusRequest.Config []*ClientConfig `json:"config,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Config") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Config") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (ClientStatusResponse)MarshalJSON¶
func (sClientStatusResponse) MarshalJSON() ([]byte,error)
typeClustersConfigDump¶
type ClustersConfigDump struct {// DynamicActiveClusters: The dynamically loaded active clusters. These are// clusters that are available to service data plane traffic.DynamicActiveClusters []*DynamicCluster `json:"dynamicActiveClusters,omitempty"`// DynamicWarmingClusters: The dynamically loaded warming clusters. These are// clusters that are currently undergoing warming in preparation to service// data plane traffic. Note that if attempting to recreate an Envoy// configuration from a configuration dump, the warming clusters should// generally be discarded.DynamicWarmingClusters []*DynamicCluster `json:"dynamicWarmingClusters,omitempty"`// StaticClusters: The statically loaded cluster configs.StaticClusters []*StaticCluster `json:"staticClusters,omitempty"`// VersionInfo: This is the :ref:`version_info ` in the last processed CDS// discovery response. If there are only static bootstrap clusters, this field// will be "".VersionInfostring `json:"versionInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "DynamicActiveClusters") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DynamicActiveClusters") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ClustersConfigDump: Envoy's cluster manager fills this message with allcurrently known clusters. Cluster configuration information can be used torecreate an Envoy configuration by populating all clusters as staticclusters or by returning them in a CDS response.
func (ClustersConfigDump)MarshalJSON¶
func (sClustersConfigDump) MarshalJSON() ([]byte,error)
typeDiscoveryClientStatusCall¶
type DiscoveryClientStatusCall struct {// contains filtered or unexported fields}func (*DiscoveryClientStatusCall)Context¶
func (c *DiscoveryClientStatusCall) Context(ctxcontext.Context) *DiscoveryClientStatusCall
Context sets the context to be used in this call's Do method.
func (*DiscoveryClientStatusCall)Do¶
func (c *DiscoveryClientStatusCall) Do(opts ...googleapi.CallOption) (*ClientStatusResponse,error)
Do executes the "trafficdirector.discovery.client_status" call.Any non-2xx status code is an error. Response headers are in either*ClientStatusResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*DiscoveryClientStatusCall)Fields¶
func (c *DiscoveryClientStatusCall) Fields(s ...googleapi.Field) *DiscoveryClientStatusCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*DiscoveryClientStatusCall)Header¶
func (c *DiscoveryClientStatusCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeDiscoveryService¶
type DiscoveryService struct {// contains filtered or unexported fields}funcNewDiscoveryService¶
func NewDiscoveryService(s *Service) *DiscoveryService
func (*DiscoveryService)ClientStatus¶
func (r *DiscoveryService) ClientStatus(clientstatusrequest *ClientStatusRequest) *DiscoveryClientStatusCall
ClientStatus:
typeDoubleMatcher¶
type DoubleMatcher struct {// Exact: If specified, the input double value must be equal to the value// specified here.Exactfloat64 `json:"exact,omitempty"`// Range: If specified, the input double value must be in the range specified// here. Note: The range is using half-open interval semantics [start, end).Range *DoubleRange `json:"range,omitempty"`// ForceSendFields is a list of field names (e.g. "Exact") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Exact") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DoubleMatcher: Specifies the way to match a double value.
func (DoubleMatcher)MarshalJSON¶
func (sDoubleMatcher) MarshalJSON() ([]byte,error)
func (*DoubleMatcher)UnmarshalJSON¶
func (s *DoubleMatcher) UnmarshalJSON(data []byte)error
typeDoubleRange¶
type DoubleRange struct {// End: end of the range (exclusive)Endfloat64 `json:"end,omitempty"`// Start: start of the range (inclusive)Startfloat64 `json:"start,omitempty"`// ForceSendFields is a list of field names (e.g. "End") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "End") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DoubleRange: Specifies the double start and end of the range using half-openinterval semantics [start, end).
func (DoubleRange)MarshalJSON¶
func (sDoubleRange) MarshalJSON() ([]byte,error)
func (*DoubleRange)UnmarshalJSON¶
func (s *DoubleRange) UnmarshalJSON(data []byte)error
typeDynamicCluster¶
type DynamicCluster struct {// Cluster: The cluster config.Clustergoogleapi.RawMessage `json:"cluster,omitempty"`// LastUpdated: The timestamp when the Cluster was last updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// VersionInfo: This is the per-resource version information. This version is// currently taken from the :ref:`version_info ` field at the time that the// cluster was loaded. In the future, discrete per-cluster versions may be// supported by the API.VersionInfostring `json:"versionInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "Cluster") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cluster") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DynamicCluster: Describes a dynamically loaded cluster via the CDS API.
func (DynamicCluster)MarshalJSON¶
func (sDynamicCluster) MarshalJSON() ([]byte,error)
typeDynamicListener¶
type DynamicListener struct {// ActiveState: The listener state for any active listener by this name. These// are listeners that are available to service data plane traffic.ActiveState *DynamicListenerState `json:"activeState,omitempty"`// DrainingState: The listener state for any draining listener by this name.// These are listeners that are currently undergoing draining in preparation to// stop servicing data plane traffic. Note that if attempting to recreate an// Envoy configuration from a configuration dump, the draining listeners should// generally be discarded.DrainingState *DynamicListenerState `json:"drainingState,omitempty"`// ErrorState: Set if the last update failed, cleared after the next successful// update.ErrorState *UpdateFailureState `json:"errorState,omitempty"`// Name: The name or unique id of this listener, pulled from the// DynamicListenerState config.Namestring `json:"name,omitempty"`// WarmingState: The listener state for any warming listener by this name.// These are listeners that are currently undergoing warming in preparation to// service data plane traffic. Note that if attempting to recreate an Envoy// configuration from a configuration dump, the warming listeners should// generally be discarded.WarmingState *DynamicListenerState `json:"warmingState,omitempty"`// ForceSendFields is a list of field names (e.g. "ActiveState") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActiveState") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DynamicListener: Describes a dynamically loaded listener via the LDS API.[#next-free-field: 6]
func (DynamicListener)MarshalJSON¶
func (sDynamicListener) MarshalJSON() ([]byte,error)
typeDynamicListenerState¶
type DynamicListenerState struct {// LastUpdated: The timestamp when the Listener was last successfully updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// Listener: The listener config.Listenergoogleapi.RawMessage `json:"listener,omitempty"`// VersionInfo: This is the per-resource version information. This version is// currently taken from the :ref:`version_info ` field at the time that the// listener was loaded. In the future, discrete per-listener versions may be// supported by the API.VersionInfostring `json:"versionInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "LastUpdated") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastUpdated") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (DynamicListenerState)MarshalJSON¶
func (sDynamicListenerState) MarshalJSON() ([]byte,error)
typeDynamicRouteConfig¶
type DynamicRouteConfig struct {// LastUpdated: The timestamp when the Route was last updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// RouteConfig: The route config.RouteConfiggoogleapi.RawMessage `json:"routeConfig,omitempty"`// VersionInfo: This is the per-resource version information. This version is// currently taken from the :ref:`version_info ` field at the time that the// route configuration was loaded.VersionInfostring `json:"versionInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "LastUpdated") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastUpdated") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (DynamicRouteConfig)MarshalJSON¶
func (sDynamicRouteConfig) MarshalJSON() ([]byte,error)
typeDynamicScopedRouteConfigs¶
type DynamicScopedRouteConfigs struct {// LastUpdated: The timestamp when the scoped route config set was last// updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// Name: The name assigned to the scoped route configurations.Namestring `json:"name,omitempty"`// ScopedRouteConfigs: The scoped route configurations.ScopedRouteConfigs []googleapi.RawMessage `json:"scopedRouteConfigs,omitempty"`// VersionInfo: This is the per-resource version information. This version is// currently taken from the :ref:`version_info ` field at the time that the// scoped routes configuration was loaded.VersionInfostring `json:"versionInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "LastUpdated") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastUpdated") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (DynamicScopedRouteConfigs)MarshalJSON¶
func (sDynamicScopedRouteConfigs) MarshalJSON() ([]byte,error)
typeExtension¶
type Extension struct {// Category: Category of the extension. Extension category names use reverse// DNS notation. For instance "envoy.filters.listener" for Envoy's built-in// listener filters or "com.acme.filters.http" for HTTP filters from acme.com// vendor. [#comment:Categorystring `json:"category,omitempty"`// Disabled: Indicates that the extension is present but was disabled via// dynamic configuration.Disabledbool `json:"disabled,omitempty"`// Name: This is the name of the Envoy filter as specified in the Envoy// configuration, e.g. envoy.filters.http.router, com.acme.widget.Namestring `json:"name,omitempty"`// TypeDescriptor: [#not-implemented-hide:] Type descriptor of extension// configuration proto. [#comment:TypeDescriptorstring `json:"typeDescriptor,omitempty"`// Version: The version is a property of the extension and maintained// independently of other extensions and the Envoy API. This field is not set// when extension did not provide version information.Version *BuildVersion `json:"version,omitempty"`// ForceSendFields is a list of field names (e.g. "Category") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Category") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Extension: Version and identification for an Envoy extension.[#next-free-field: 6]
func (Extension)MarshalJSON¶
typeGoogleRE2¶
type GoogleRE2 struct {// MaxProgramSize: This field controls the RE2 "program size" which is a rough// estimate of how complex a compiled regex is to evaluate. A regex that has a// program size greater than the configured value will fail to compile. In this// case, the configured max program size can be increased or the regex can be// simplified. If not specified, the default is 100. This field is deprecated;// regexp validation should be performed on the management server instead of// being done by each individual client.MaxProgramSizeint64 `json:"maxProgramSize,omitempty"`// ForceSendFields is a list of field names (e.g. "MaxProgramSize") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxProgramSize") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleRE2: Google's `RE2 `_ regex engine. The regex string must adhere tothe documented `syntax `_. The engine is designed to complete execution inlinear time as well as limit the amount of memory used. Envoy supportsprogram size checking via runtime. The runtime keys“re2.max_program_size.error_level“ and “re2.max_program_size.warn_level“can be set to integers as the maximum program size or complexity that acompiled regex can have before an exception is thrown or a warning islogged, respectively. “re2.max_program_size.error_level“ defaults to 100,and “re2.max_program_size.warn_level“ has no default if unset (will notcheck/log a warning). Envoy emits two stats for tracking the program size ofregexes: the histogram `re2.program_size`, which records the program size,and the counter `re2.exceeded_warn_level`, which is incremented each timethe program size exceeds the warn level threshold.
func (GoogleRE2)MarshalJSON¶
typeInlineScopedRouteConfigs¶
type InlineScopedRouteConfigs struct {// LastUpdated: The timestamp when the scoped route config set was last// updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// Name: The name assigned to the scoped route configurations.Namestring `json:"name,omitempty"`// ScopedRouteConfigs: The scoped route configurations.ScopedRouteConfigs []googleapi.RawMessage `json:"scopedRouteConfigs,omitempty"`// ForceSendFields is a list of field names (e.g. "LastUpdated") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastUpdated") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (InlineScopedRouteConfigs)MarshalJSON¶
func (sInlineScopedRouteConfigs) MarshalJSON() ([]byte,error)
typeListMatcher¶
type ListMatcher struct {// OneOf: If specified, at least one of the values in the list must match the// value specified.OneOf *ValueMatcher `json:"oneOf,omitempty"`// ForceSendFields is a list of field names (e.g. "OneOf") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OneOf") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListMatcher: Specifies the way to match a list value.
func (ListMatcher)MarshalJSON¶
func (sListMatcher) MarshalJSON() ([]byte,error)
typeListenersConfigDump¶
type ListenersConfigDump struct {// DynamicListeners: State for any warming, active, or draining listeners.DynamicListeners []*DynamicListener `json:"dynamicListeners,omitempty"`// StaticListeners: The statically loaded listener configs.StaticListeners []*StaticListener `json:"staticListeners,omitempty"`// VersionInfo: This is the :ref:`version_info ` in the last processed LDS// discovery response. If there are only static bootstrap listeners, this field// will be "".VersionInfostring `json:"versionInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "DynamicListeners") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DynamicListeners") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ListenersConfigDump: Envoy's listener manager fills this message with allcurrently known listeners. Listener configuration information can be used torecreate an Envoy configuration by populating all listeners as staticlisteners or by returning them in a LDS response.
func (ListenersConfigDump)MarshalJSON¶
func (sListenersConfigDump) MarshalJSON() ([]byte,error)
typeLocality¶
type Locality struct {// Region: Region this :ref:`zone ` belongs to.Regionstring `json:"region,omitempty"`// SubZone: When used for locality of upstream hosts, this field further splits// zone into smaller chunks of sub-zones so they can be load balanced// independently.SubZonestring `json:"subZone,omitempty"`// Zone: Defines the local service zone where Envoy is running. Though// optional, it should be set if discovery service routing is used and the// discovery service exposes :ref:`zone data `, either in this message or via// :option:`--service-zone`. The meaning of zone is context dependent, e.g.// `Availability Zone (AZ) `_ on AWS, `Zone `_ on GCP, etc.Zonestring `json:"zone,omitempty"`// ForceSendFields is a list of field names (e.g. "Region") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Region") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Locality: Identifies location of where either Envoy runs or where upstreamhosts run.
func (Locality)MarshalJSON¶
typeNode¶
type Node struct {// BuildVersion: This is motivated by informing a management server during// canary which version of Envoy is being tested in a heterogeneous fleet. This// will be set by Envoy in management server RPCs. This field is deprecated in// favor of the user_agent_name and user_agent_version values.BuildVersionstring `json:"buildVersion,omitempty"`// ClientFeatures: Client feature support list. These are well known features// described in the Envoy API repository for a given major version of an API.// Client features use reverse DNS naming scheme, for example// `com.acme.feature`. See :ref:`the list of features ` that xDS client may// support.ClientFeatures []string `json:"clientFeatures,omitempty"`// Cluster: Defines the local service cluster name where Envoy is running.// Though optional, it should be set if any of the following features are used:// :ref:`statsd `, :ref:`health check cluster verification `, :ref:`runtime// override directory `, :ref:`user agent addition `, :ref:`HTTP global rate// limiting `, :ref:`CDS `, and :ref:`HTTP tracing `, either in this message or// via :option:`--service-cluster`.Clusterstring `json:"cluster,omitempty"`// Extensions: List of extensions and their versions supported by the node.Extensions []*Extension `json:"extensions,omitempty"`// Id: An opaque node identifier for the Envoy node. This also provides the// local service node name. It should be set if any of the following features// are used: :ref:`statsd `, :ref:`CDS `, and :ref:`HTTP tracing `, either in// this message or via :option:`--service-node`.Idstring `json:"id,omitempty"`// ListeningAddresses: Known listening ports on the node as a generic hint to// the management server for filtering :ref:`listeners ` to be returned. For// example, if there is a listener bound to port 80, the list can optionally// contain the SocketAddress `(0.0.0.0,80)`. The field is optional and just a// hint.ListeningAddresses []*Address `json:"listeningAddresses,omitempty"`// Locality: Locality specifying where the Envoy instance is running.Locality *Locality `json:"locality,omitempty"`// Metadata: Opaque metadata extending the node identifier. Envoy will pass// this directly to the management server.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// UserAgentBuildVersion: Structured version of the entity requesting config.UserAgentBuildVersion *BuildVersion `json:"userAgentBuildVersion,omitempty"`// UserAgentName: Free-form string that identifies the entity requesting// config. E.g. "envoy" or "grpc"UserAgentNamestring `json:"userAgentName,omitempty"`// UserAgentVersion: Free-form string that identifies the version of the entity// requesting config. E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"UserAgentVersionstring `json:"userAgentVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "BuildVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BuildVersion") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Node: Identifies a specific Envoy instance. The node identifier is presentedto the management server, which may use this identifier to distinguish perEnvoy configuration for serving. [#next-free-field: 12]
func (Node)MarshalJSON¶
typeNodeMatcher¶
type NodeMatcher struct {// NodeId: Specifies match criteria on the node id.NodeId *StringMatcher `json:"nodeId,omitempty"`// NodeMetadatas: Specifies match criteria on the node metadata.NodeMetadatas []*StructMatcher `json:"nodeMetadatas,omitempty"`// ForceSendFields is a list of field names (e.g. "NodeId") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NodeId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}NodeMatcher: Specifies the way to match a Node. The match follows ANDsemantics.
func (NodeMatcher)MarshalJSON¶
func (sNodeMatcher) MarshalJSON() ([]byte,error)
typeNullMatch¶
type NullMatch struct {}NullMatch: NullMatch is an empty message to specify a null value.
typePathSegment¶
type PathSegment struct {// Key: If specified, use the key to retrieve the value in a Struct.Keystring `json:"key,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Key") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PathSegment: Specifies the segment in a path to retrieve value from Struct.
func (PathSegment)MarshalJSON¶
func (sPathSegment) MarshalJSON() ([]byte,error)
typePerXdsConfig¶
type PerXdsConfig struct {ClusterConfig *ClustersConfigDump `json:"clusterConfig,omitempty"`ListenerConfig *ListenersConfigDump `json:"listenerConfig,omitempty"`RouteConfig *RoutesConfigDump `json:"routeConfig,omitempty"`ScopedRouteConfig *ScopedRoutesConfigDump `json:"scopedRouteConfig,omitempty"`// Possible values:// "UNKNOWN" - Status info is not available/unknown.// "SYNCED" - Management server has sent the config to client and received// ACK.// "NOT_SENT" - Config is not sent.// "STALE" - Management server has sent the config to client but hasn’t// received ACK/NACK.// "ERROR" - Management server has sent the config to client but received// NACK.Statusstring `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "ClusterConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClusterConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}PerXdsConfig: Detailed config (per xDS) with status. [#next-free-field: 6]
func (PerXdsConfig)MarshalJSON¶
func (sPerXdsConfig) MarshalJSON() ([]byte,error)
typePipe¶
type Pipe struct {// Mode: The mode for the Pipe. Not applicable for abstract sockets.Modeint64 `json:"mode,omitempty"`// Path: Unix Domain Socket path. On Linux, paths starting with '@' will use// the abstract namespace. The starting '@' is replaced by a null byte by// Envoy. Paths starting with '@' will result in an error in environments other// than Linux.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "Mode") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Mode") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (Pipe)MarshalJSON¶
typeRegexMatcher¶
type RegexMatcher struct {// GoogleRe2: Google's RE2 regex engine.GoogleRe2 *GoogleRE2 `json:"googleRe2,omitempty"`// Regex: The regex match string. The string must be supported by the// configured engine.Regexstring `json:"regex,omitempty"`// ForceSendFields is a list of field names (e.g. "GoogleRe2") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GoogleRe2") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RegexMatcher: A regex matcher designed for safety when used with untrustedinput.
func (RegexMatcher)MarshalJSON¶
func (sRegexMatcher) MarshalJSON() ([]byte,error)
typeRoutesConfigDump¶
type RoutesConfigDump struct {// DynamicRouteConfigs: The dynamically loaded route configs.DynamicRouteConfigs []*DynamicRouteConfig `json:"dynamicRouteConfigs,omitempty"`// StaticRouteConfigs: The statically loaded route configs.StaticRouteConfigs []*StaticRouteConfig `json:"staticRouteConfigs,omitempty"`// ForceSendFields is a list of field names (e.g. "DynamicRouteConfigs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DynamicRouteConfigs") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RoutesConfigDump: Envoy's RDS implementation fills this message with allcurrently loaded routes, as described by their RouteConfiguration objects.Static routes that are either defined in the bootstrap configuration ordefined inline while configuring listeners are separated from thoseconfigured dynamically via RDS. Route configuration information can be usedto recreate an Envoy configuration by populating all routes as static routesor by returning them in RDS responses.
func (RoutesConfigDump)MarshalJSON¶
func (sRoutesConfigDump) MarshalJSON() ([]byte,error)
typeScopedRoutesConfigDump¶
type ScopedRoutesConfigDump struct {// DynamicScopedRouteConfigs: The dynamically loaded scoped route configs.DynamicScopedRouteConfigs []*DynamicScopedRouteConfigs `json:"dynamicScopedRouteConfigs,omitempty"`// InlineScopedRouteConfigs: The statically loaded scoped route configs.InlineScopedRouteConfigs []*InlineScopedRouteConfigs `json:"inlineScopedRouteConfigs,omitempty"`// ForceSendFields is a list of field names (e.g. "DynamicScopedRouteConfigs")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DynamicScopedRouteConfigs") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ScopedRoutesConfigDump: Envoy's scoped RDS implementation fills this messagewith all currently loaded route configuration scopes (defined viaScopedRouteConfigurationsSet protos). This message lists both the scopesdefined inline with the higher order object (i.e., theHttpConnectionManager) and the dynamically obtained scopes via the SRDS API.
func (ScopedRoutesConfigDump)MarshalJSON¶
func (sScopedRoutesConfigDump) MarshalJSON() ([]byte,error)
typeSemanticVersion¶
type SemanticVersion struct {MajorNumberint64 `json:"majorNumber,omitempty"`MinorNumberint64 `json:"minorNumber,omitempty"`Patchint64 `json:"patch,omitempty"`// ForceSendFields is a list of field names (e.g. "MajorNumber") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MajorNumber") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SemanticVersion: Envoy uses SemVer (https://semver.org/). Major/minorversions indicate expected behaviors and APIs, the patch version field isused only for security fixes and can be generally ignored.
func (SemanticVersion)MarshalJSON¶
func (sSemanticVersion) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentDiscovery *DiscoveryService// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶
NewService creates a new Service.
typeSocketAddress¶
type SocketAddress struct {// Address: The address for this socket. :ref:`Listeners ` will bind to the// address. An empty address is not allowed. Specify “0.0.0.0“ or “::“ to// bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It// is possible to distinguish a Listener address via the prefix/suffix matching// in :ref:`FilterChainMatch `.] When used within an upstream :ref:`BindConfig// `, the address controls the source address of outbound connections. For// :ref:`clusters `, the cluster type determines whether the address must be an// IP (*STATIC* or *EDS* clusters) or a hostname resolved by DNS (*STRICT_DNS*// or *LOGICAL_DNS* clusters). Address resolution can be customized via// :ref:`resolver_name `.Addressstring `json:"address,omitempty"`// Ipv4Compat: When binding to an IPv6 address above, this enables `IPv4// compatibility `_. Binding to “::“ will allow both IPv4 and IPv6// connections, with peer IPv4 addresses mapped into IPv6 space as “::FFFF:“.Ipv4Compatbool `json:"ipv4Compat,omitempty"`// NamedPort: This is only valid if :ref:`resolver_name ` is specified below// and the named resolver is capable of named port resolution.NamedPortstring `json:"namedPort,omitempty"`PortValueint64 `json:"portValue,omitempty"`// Possible values:// "TCP"// "UDP"Protocolstring `json:"protocol,omitempty"`// ResolverName: The name of the custom resolver. This must have been// registered with Envoy. If this is empty, a context dependent default// applies. If the address is a concrete IP address, no resolution will occur.// If address is a hostname this should be set for resolution other than DNS.// Specifying a custom resolver with *STRICT_DNS* or *LOGICAL_DNS* will// generate an error at runtime.ResolverNamestring `json:"resolverName,omitempty"`// ForceSendFields is a list of field names (e.g. "Address") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Address") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SocketAddress: [#next-free-field: 7]
func (SocketAddress)MarshalJSON¶
func (sSocketAddress) MarshalJSON() ([]byte,error)
typeStaticCluster¶
type StaticCluster struct {// Cluster: The cluster config.Clustergoogleapi.RawMessage `json:"cluster,omitempty"`// LastUpdated: The timestamp when the Cluster was last updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// ForceSendFields is a list of field names (e.g. "Cluster") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cluster") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}StaticCluster: Describes a statically loaded cluster.
func (StaticCluster)MarshalJSON¶
func (sStaticCluster) MarshalJSON() ([]byte,error)
typeStaticListener¶
type StaticListener struct {// LastUpdated: The timestamp when the Listener was last successfully updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// Listener: The listener config.Listenergoogleapi.RawMessage `json:"listener,omitempty"`// ForceSendFields is a list of field names (e.g. "LastUpdated") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastUpdated") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}StaticListener: Describes a statically loaded listener.
func (StaticListener)MarshalJSON¶
func (sStaticListener) MarshalJSON() ([]byte,error)
typeStaticRouteConfig¶
type StaticRouteConfig struct {// LastUpdated: The timestamp when the Route was last updated.LastUpdatedstring `json:"lastUpdated,omitempty"`// RouteConfig: The route config.RouteConfiggoogleapi.RawMessage `json:"routeConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "LastUpdated") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastUpdated") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (StaticRouteConfig)MarshalJSON¶
func (sStaticRouteConfig) MarshalJSON() ([]byte,error)
typeStringMatcher¶
type StringMatcher struct {// Exact: The input string must match exactly the string specified here.// Examples: * *abc* only matches the value *abc*.Exactstring `json:"exact,omitempty"`// IgnoreCase: If true, indicates the exact/prefix/suffix matching should be// case insensitive. This has no effect for the safe_regex match. For example,// the matcher *data* will match both input string *Data* and *data* if set to// true.IgnoreCasebool `json:"ignoreCase,omitempty"`// Prefix: The input string must have the prefix specified here. Note: empty// prefix is not allowed, please use regex instead. Examples: * *abc* matches// the value *abc.xyz*Prefixstring `json:"prefix,omitempty"`// Regex: The input string must match the regular expression specified here.// The regex grammar is defined `here `_. Examples: * The regex “\d{3}“// matches the value *123* * The regex “\d{3}“ does not match the value// *1234* * The regex “\d{3}“ does not match the value *123.456* ..// attention:: This field has been deprecated in favor of `safe_regex` as it is// not safe for use with untrusted input in all cases.Regexstring `json:"regex,omitempty"`// SafeRegex: The input string must match the regular expression specified// here.SafeRegex *RegexMatcher `json:"safeRegex,omitempty"`// Suffix: The input string must have the suffix specified here. Note: empty// prefix is not allowed, please use regex instead. Examples: * *abc* matches// the value *xyz.abc*Suffixstring `json:"suffix,omitempty"`// ForceSendFields is a list of field names (e.g. "Exact") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Exact") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}StringMatcher: Specifies the way to match a string. [#next-free-field: 7]
func (StringMatcher)MarshalJSON¶
func (sStringMatcher) MarshalJSON() ([]byte,error)
typeStructMatcher¶
type StructMatcher struct {// Path: The path to retrieve the Value from the Struct.Path []*PathSegment `json:"path,omitempty"`// Value: The StructMatcher is matched if the value retrieved by path is// matched to this value.Value *ValueMatcher `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Path") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Path") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}StructMatcher: StructMatcher provides a general interface to check if agiven value is matched in google.protobuf.Struct. It uses `path` to retrievethe value from the struct and then check if it's matched to the specifiedvalue. For example, for the following Struct: .. code-block:: yaml fields:a: struct_value: fields: b: struct_value: fields: c: string_value: pro t:list_value: values: - string_value: m - string_value: n The followingMetadataMatcher is matched as the path [a, b, c] will retrieve a stringvalue "pro" from the Metadata which is matched to the specified prefixmatch. .. code-block:: yaml path: - key: a - key: b - key: c value:string_match: prefix: pr The following StructMatcher is matched as the codewill match one of the string values in the list at the path [a, t]. ..code-block:: yaml path: - key: a - key: t value: list_match: one_of:string_match: exact: m An example use of StructMatcher is to match metadatain envoy.v*.core.Node.
func (StructMatcher)MarshalJSON¶
func (sStructMatcher) MarshalJSON() ([]byte,error)
typeUpdateFailureState¶
type UpdateFailureState struct {// Details: Details about the last failed update attempt.Detailsstring `json:"details,omitempty"`// FailedConfiguration: What the component configuration would have been if the// update had succeeded.FailedConfigurationgoogleapi.RawMessage `json:"failedConfiguration,omitempty"`// LastUpdateAttempt: Time of the latest failed update attempt.LastUpdateAttemptstring `json:"lastUpdateAttempt,omitempty"`// ForceSendFields is a list of field names (e.g. "Details") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Details") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (UpdateFailureState)MarshalJSON¶
func (sUpdateFailureState) MarshalJSON() ([]byte,error)
typeValueMatcher¶
type ValueMatcher struct {// BoolMatch: If specified, a match occurs if and only if the target value is a// bool value and is equal to this field.BoolMatchbool `json:"boolMatch,omitempty"`// DoubleMatch: If specified, a match occurs if and only if the target value is// a double value and is matched to this field.DoubleMatch *DoubleMatcher `json:"doubleMatch,omitempty"`// ListMatch: If specified, a match occurs if and only if the target value is a// list value and is matched to this field.ListMatch *ListMatcher `json:"listMatch,omitempty"`// NullMatch: If specified, a match occurs if and only if the target value is a// NullValue.NullMatch *NullMatch `json:"nullMatch,omitempty"`// PresentMatch: If specified, value match will be performed based on whether// the path is referring to a valid primitive value in the metadata. If the// path is referring to a non-primitive value, the result is always not// matched.PresentMatchbool `json:"presentMatch,omitempty"`// StringMatch: If specified, a match occurs if and only if the target value is// a string value and is matched to this field.StringMatch *StringMatcher `json:"stringMatch,omitempty"`// ForceSendFields is a list of field names (e.g. "BoolMatch") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoolMatch") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ValueMatcher: Specifies the way to match a Protobuf::Value. Primitive valuesand ListValue are supported. StructValue is not supported and is always notmatched. [#next-free-field: 7]
func (ValueMatcher)MarshalJSON¶
func (sValueMatcher) MarshalJSON() ([]byte,error)