apigee

package
Version: v0.0.0-...-e229cca Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 23, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var E_Immutable = &proto.ExtensionDesc{
	ExtendedType:  (*descriptor.FieldOptions)(nil),
	ExtensionType: (*bool)(nil),
	Field:         23939889,
	Name:          "apigee.immutable",
	Tag:           "varint,23939889,opt,name=immutable",
	Filename:      "external_callout.proto",
}

Functions

func RegisterExternalCalloutServiceServer

func RegisterExternalCalloutServiceServer(s *grpc.Server, srv ExternalCalloutServiceServer)

Types

type ApiProxy

type ApiProxy struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Revision             string   `protobuf:"bytes,2,opt,name=revision,proto3" json:"revision,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TODO(b/183420583): Add support for apiproxy.basepath. Message containing ApiProxy-related properties. This is the information specified in the XML file that contains <APIProxy> element. https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#apiproxy

func (*ApiProxy) Descriptor

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

func (*ApiProxy) GetName

func (m *ApiProxy) GetName() string

func (*ApiProxy) GetRevision

func (m *ApiProxy) GetRevision() string

func (*ApiProxy) ProtoMessage

func (*ApiProxy) ProtoMessage()

func (*ApiProxy) Reset

func (m *ApiProxy) Reset()

func (*ApiProxy) String

func (m *ApiProxy) String() string

func (*ApiProxy) XXX_DiscardUnknown

func (m *ApiProxy) XXX_DiscardUnknown()

func (*ApiProxy) XXX_Marshal

func (m *ApiProxy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ApiProxy) XXX_Merge

func (m *ApiProxy) XXX_Merge(src proto.Message)

func (*ApiProxy) XXX_Size

func (m *ApiProxy) XXX_Size() int

func (*ApiProxy) XXX_Unmarshal

func (m *ApiProxy) XXX_Unmarshal(b []byte) error

type Client

type Client struct {
	Cn                   string   `protobuf:"bytes,1,opt,name=cn,proto3" json:"cn,omitempty"`
	Country              string   `protobuf:"bytes,2,opt,name=country,proto3" json:"country,omitempty"`
	EmailAddress         string   `protobuf:"bytes,3,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"`
	Host                 string   `protobuf:"bytes,4,opt,name=host,proto3" json:"host,omitempty"`
	Ip                   string   `protobuf:"bytes,5,opt,name=ip,proto3" json:"ip,omitempty"`
	Locality             string   `protobuf:"bytes,6,opt,name=locality,proto3" json:"locality,omitempty"`
	Organization         string   `protobuf:"bytes,7,opt,name=organization,proto3" json:"organization,omitempty"`
	OrganizationUnit     string   `protobuf:"bytes,8,opt,name=organization_unit,json=organizationUnit,proto3" json:"organization_unit,omitempty"`
	Port                 int32    `protobuf:"varint,9,opt,name=port,proto3" json:"port,omitempty"`
	Scheme               string   `protobuf:"bytes,10,opt,name=scheme,proto3" json:"scheme,omitempty"`
	State                string   `protobuf:"bytes,11,opt,name=state,proto3" json:"state,omitempty"`
	SslEnabled           bool     `protobuf:"varint,12,opt,name=ssl_enabled,json=sslEnabled,proto3" json:"ssl_enabled,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Message representing a client. Client refers to the application or system that sent a request to the Edge Runtime. https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#client

func (*Client) Descriptor

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

func (*Client) GetCn

func (m *Client) GetCn() string

func (*Client) GetCountry

func (m *Client) GetCountry() string

func (*Client) GetEmailAddress

func (m *Client) GetEmailAddress() string

func (*Client) GetHost

func (m *Client) GetHost() string

func (*Client) GetIp

func (m *Client) GetIp() string

func (*Client) GetLocality

func (m *Client) GetLocality() string

func (*Client) GetOrganization

func (m *Client) GetOrganization() string

func (*Client) GetOrganizationUnit

func (m *Client) GetOrganizationUnit() string

func (*Client) GetPort

func (m *Client) GetPort() int32

func (*Client) GetScheme

func (m *Client) GetScheme() string

func (*Client) GetSslEnabled

func (m *Client) GetSslEnabled() bool

func (*Client) GetState

func (m *Client) GetState() string

func (*Client) ProtoMessage

func (*Client) ProtoMessage()

func (*Client) Reset

func (m *Client) Reset()

func (*Client) String

func (m *Client) String() string

func (*Client) XXX_DiscardUnknown

func (m *Client) XXX_DiscardUnknown()

func (*Client) XXX_Marshal

func (m *Client) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Client) XXX_Merge

func (m *Client) XXX_Merge(src proto.Message)

func (*Client) XXX_Size

func (m *Client) XXX_Size() int

func (*Client) XXX_Unmarshal

func (m *Client) XXX_Unmarshal(b []byte) error

type CurrentFlow

type CurrentFlow struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Description          string   `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#current

func (*CurrentFlow) Descriptor

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

func (*CurrentFlow) GetDescription

func (m *CurrentFlow) GetDescription() string

func (*CurrentFlow) GetName

func (m *CurrentFlow) GetName() string

func (*CurrentFlow) ProtoMessage

func (*CurrentFlow) ProtoMessage()

func (*CurrentFlow) Reset

func (m *CurrentFlow) Reset()

func (*CurrentFlow) String

func (m *CurrentFlow) String() string

func (*CurrentFlow) XXX_DiscardUnknown

func (m *CurrentFlow) XXX_DiscardUnknown()

func (*CurrentFlow) XXX_Marshal

func (m *CurrentFlow) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CurrentFlow) XXX_Merge

func (m *CurrentFlow) XXX_Merge(src proto.Message)

func (*CurrentFlow) XXX_Size

func (m *CurrentFlow) XXX_Size() int

func (*CurrentFlow) XXX_Unmarshal

func (m *CurrentFlow) XXX_Unmarshal(b []byte) error

type Error

type Error struct {
	// The error message.  This is the `fault_string` of the fault that caused the
	// flow to enter error flow.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// This field stands for the error response once the execution enters error
	// flow. Contains status code, reason phrase, header, and content.
	Response             *Response `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

TODO(b/183420583): Add support for error.state and fault.name. https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#error

Error is populated when the execution flow enters error flow due to a fault being raised. When this message populated, is.error is true. https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#is

The following flow variables have been omitted: - transport.message: contains info already listed below (code, content, etc.)

func (*Error) Descriptor

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

func (*Error) GetMessage

func (m *Error) GetMessage() string

func (*Error) GetResponse

func (m *Error) GetResponse() *Response

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) Reset

func (m *Error) Reset()

func (*Error) String

func (m *Error) String() string

func (*Error) XXX_DiscardUnknown

func (m *Error) XXX_DiscardUnknown()

func (*Error) XXX_Marshal

func (m *Error) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Error) XXX_Merge

func (m *Error) XXX_Merge(src proto.Message)

func (*Error) XXX_Size

func (m *Error) XXX_Size() int

func (*Error) XXX_Unmarshal

func (m *Error) XXX_Unmarshal(b []byte) error

type ExternalCalloutServiceClient

type ExternalCalloutServiceClient interface {
	// This method takes a MessageContext and returns a modified MessageContext.
	// See the commentary on MessageContext for how to use it.
	//
	// The exceptions thrown by the implementation of the gRPC service will be
	// translated into faults by the message processor.
	ProcessMessage(ctx context.Context, in *MessageContext, opts ...grpc.CallOption) (*MessageContext, error)
}

ExternalCalloutServiceClient is the client API for ExternalCalloutService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewExternalCalloutServiceClient

func NewExternalCalloutServiceClient(cc *grpc.ClientConn) ExternalCalloutServiceClient

type ExternalCalloutServiceServer

type ExternalCalloutServiceServer interface {
	// This method takes a MessageContext and returns a modified MessageContext.
	// See the commentary on MessageContext for how to use it.
	//
	// The exceptions thrown by the implementation of the gRPC service will be
	// translated into faults by the message processor.
	ProcessMessage(context.Context, *MessageContext) (*MessageContext, error)
}

ExternalCalloutServiceServer is the server API for ExternalCalloutService service.

type Fault

type Fault struct {
	// The following is a text representation of a fault:
	//
	// {
	//   "fault":{
	//      "detail":{
	//         "errorcode":"steps.extractvariables.SourceMessageNotAvailable"
	//      },
	//      "faultstring":"foo message is not available for ExtractVariable: ParseJsonResponse"
	//   }
	// }
	//
	// "name" is the last part of "errorcode" (SourceMessageNotAvailable).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// When a fault is triggered by a RaiseFault policy, this is set.  See also
	// https://cloud.google.com/apigee/docs/api-platform/reference/policies/raise-fault-policy#flowvariables
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// When a fault is triggered by a RaiseFault policy, this is set.  See also
	// https://cloud.google.com/apigee/docs/api-platform/reference/policies/raise-fault-policy#flowvariables
	// This can be step, transport, for example.  When it's step, it means the
	// fault was raised when executing some policy (a.k.a. "step").
	Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
	// String corresponding to the fault. In some Apigee docs, you may see this
	// field referred to as 'reason'.
	FaultString          string   `protobuf:"bytes,4,opt,name=fault_string,json=faultString,proto3" json:"fault_string,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

TODO(christinezhou): Review this documentation. Message representing a fault.

For more about faults, see: https://cloud.google.com/apigee/docs/api-platform/fundamentals/fault-handling

For more about a fault's fields, see: https://cloud.google.com/apigee/docs/api-platform/fundamentals/what-you-need-know-about-policy-errors

For the information available when a fault occurs, see: https://cloud.google.com/apigee/docs/api-platform/fundamentals/fault-handling#buildingconditions-otheravailablevariables

Note that External Callout policy can be used in a FaultRule.

func (*Fault) Descriptor

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

func (*Fault) GetCategory

func (m *Fault) GetCategory() string

func (*Fault) GetFaultString

func (m *Fault) GetFaultString() string

func (*Fault) GetName

func (m *Fault) GetName() string

func (*Fault) GetType

func (m *Fault) GetType() string

func (*Fault) ProtoMessage

func (*Fault) ProtoMessage()

func (*Fault) Reset

func (m *Fault) Reset()

func (*Fault) String

func (m *Fault) String() string

func (*Fault) XXX_DiscardUnknown

func (m *Fault) XXX_DiscardUnknown()

func (*Fault) XXX_Marshal

func (m *Fault) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Fault) XXX_Merge

func (m *Fault) XXX_Merge(src proto.Message)

func (*Fault) XXX_Size

func (m *Fault) XXX_Size() int

func (*Fault) XXX_Unmarshal

func (m *Fault) XXX_Unmarshal(b []byte) error

type FlowVariable

type FlowVariable struct {
	// Types that are valid to be assigned to Value:
	//	*FlowVariable_Int32
	//	*FlowVariable_Int64
	//	*FlowVariable_String_
	//	*FlowVariable_Bool
	//	*FlowVariable_Double
	Value                isFlowVariable_Value `protobuf_oneof:"value"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

The supported value types for additional flow variables. For now, only primitive types are supported.

func (*FlowVariable) Descriptor

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

func (*FlowVariable) GetBool

func (m *FlowVariable) GetBool() bool

func (*FlowVariable) GetDouble

func (m *FlowVariable) GetDouble() float64

func (*FlowVariable) GetInt32

func (m *FlowVariable) GetInt32() int32

func (*FlowVariable) GetInt64

func (m *FlowVariable) GetInt64() int64

func (*FlowVariable) GetString_

func (m *FlowVariable) GetString_() string

func (*FlowVariable) GetValue

func (m *FlowVariable) GetValue() isFlowVariable_Value

func (*FlowVariable) ProtoMessage

func (*FlowVariable) ProtoMessage()

func (*FlowVariable) Reset

func (m *FlowVariable) Reset()

func (*FlowVariable) String

func (m *FlowVariable) String() string

func (*FlowVariable) XXX_DiscardUnknown

func (m *FlowVariable) XXX_DiscardUnknown()

func (*FlowVariable) XXX_Marshal

func (m *FlowVariable) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FlowVariable) XXX_Merge

func (m *FlowVariable) XXX_Merge(src proto.Message)

func (*FlowVariable) XXX_OneofWrappers

func (*FlowVariable) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*FlowVariable) XXX_Size

func (m *FlowVariable) XXX_Size() int

func (*FlowVariable) XXX_Unmarshal

func (m *FlowVariable) XXX_Unmarshal(b []byte) error

type FlowVariable_Bool

type FlowVariable_Bool struct {
	Bool bool `protobuf:"varint,4,opt,name=bool,proto3,oneof"`
}

type FlowVariable_Double

type FlowVariable_Double struct {
	Double float64 `protobuf:"fixed64,5,opt,name=double,proto3,oneof"`
}

type FlowVariable_Int32

type FlowVariable_Int32 struct {
	Int32 int32 `protobuf:"varint,1,opt,name=int32,proto3,oneof"`
}

type FlowVariable_Int64

type FlowVariable_Int64 struct {
	Int64 int64 `protobuf:"varint,2,opt,name=int64,proto3,oneof"`
}

type FlowVariable_String_

type FlowVariable_String_ struct {
	String_ string `protobuf:"bytes,3,opt,name=string,proto3,oneof"`
}

type MessageContext

type MessageContext struct {
	// The HTTP request, only populated when the execution is on proxy request
	// flow or target request flow.
	Request *Request `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// The response, only populated when the execution is on proxy response flow
	// or target response flow.
	Response *Response `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"`
	// The error message.  This is populated only in error flow.
	Error *Error `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// A fault object, used to raise a fault. If one populates this field within
	// the gRPC server, the runtime request will switch to the error flow with the
	// specified fault even if 'continueOnError' is true on the policy.
	//
	// Only name and fault_string need to be specified.  The errorcode will be
	// steps.externalcallout.{name}. Other fields in Fault are immutable and will
	// be determined by the Message Processor.
	Fault *Fault `protobuf:"bytes,5,opt,name=fault,proto3" json:"fault,omitempty"`
	// ApiProxy-related properties.
	ApiProxy *ApiProxy `protobuf:"bytes,6,opt,name=api_proxy,json=apiProxy,proto3" json:"api_proxy,omitempty"`
	// Properties for the client used to send Apigee Edge the request.
	Client *Client `protobuf:"bytes,7,opt,name=client,proto3" json:"client,omitempty"`
	// Properties for the current flow, e.g. target request flow.
	CurrentFlow *CurrentFlow `protobuf:"bytes,8,opt,name=current_flow,json=currentFlow,proto3" json:"current_flow,omitempty"`
	// https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#messageid
	MessageId string `protobuf:"bytes,9,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#organization
	OrganizationName string `protobuf:"bytes,10,opt,name=organization_name,json=organizationName,proto3" json:"organization_name,omitempty"`
	// https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#environment
	EnvironmentName string `protobuf:"bytes,11,opt,name=environment_name,json=environmentName,proto3" json:"environment_name,omitempty"`
	// Proxy-related and proxy-endpoint-related properties.
	Proxy *Proxy `protobuf:"bytes,12,opt,name=proxy,proto3" json:"proxy,omitempty"`
	// Properties for Route Rule and Target.
	Route *Route `protobuf:"bytes,13,opt,name=route,proto3" json:"route,omitempty"`
	// Properties for target.
	Target *Target `protobuf:"bytes,14,opt,name=target,proto3" json:"target,omitempty"`
	// Additional flow variables.  The keys are flattened out, meaning a.b.c.1 and
	// a.b.c.2 are separate entries in the map.  Note that flow variables' names
	// cannot be prefixes of other variables.  For example, when trying to add
	// a.b.c and a.b, one will override the other.  However, a.c.d and a.b can be
	// added at the same time because one is not the prefix of the other.  As
	// another example, when a.b.c and a.c exist, if one tries to add a = 5, as a
	// result, both a.b.c and a.c will be removed and 'a' will remain with a value
	// of 5.
	//
	// To remove a flow variable, set the value to the default instance of
	// FlowVariable.  Note that removing a 'parent' variable will remove all the
	// children.  For example, removing a will remove a.*.
	AdditionalFlowVariables map[string]*FlowVariable `` /* 221-byte string literal not displayed */
	XXX_NoUnkeyedLiteral    struct{}                 `json:"-"`
	XXX_unrecognized        []byte                   `json:"-"`
	XXX_sizecache           int32                    `json:"-"`
}

MessageContext includes most of the documented flow variables in the flow variable reference page: https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference

The following flow variables have been omitted: - loadbalancing, system: minimal use cases - variable: same as target.expectedcn

TODO(b/183420583): Add support for apiproduct

Modifying the mutable fields will lead to the corresponding flow variables getting updated.

func (*MessageContext) Descriptor

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

func (*MessageContext) GetAdditionalFlowVariables

func (m *MessageContext) GetAdditionalFlowVariables() map[string]*FlowVariable

func (*MessageContext) GetApiProxy

func (m *MessageContext) GetApiProxy() *ApiProxy

func (*MessageContext) GetClient

func (m *MessageContext) GetClient() *Client

func (*MessageContext) GetCurrentFlow

func (m *MessageContext) GetCurrentFlow() *CurrentFlow

func (*MessageContext) GetEnvironmentName

func (m *MessageContext) GetEnvironmentName() string

func (*MessageContext) GetError

func (m *MessageContext) GetError() *Error

func (*MessageContext) GetFault

func (m *MessageContext) GetFault() *Fault

func (*MessageContext) GetMessageId

func (m *MessageContext) GetMessageId() string

func (*MessageContext) GetOrganizationName

func (m *MessageContext) GetOrganizationName() string

func (*MessageContext) GetProxy

func (m *MessageContext) GetProxy() *Proxy

func (*MessageContext) GetRequest

func (m *MessageContext) GetRequest() *Request

func (*MessageContext) GetResponse

func (m *MessageContext) GetResponse() *Response

func (*MessageContext) GetRoute

func (m *MessageContext) GetRoute() *Route

func (*MessageContext) GetTarget

func (m *MessageContext) GetTarget() *Target

func (*MessageContext) ProtoMessage

func (*MessageContext) ProtoMessage()

func (*MessageContext) Reset

func (m *MessageContext) Reset()

func (*MessageContext) String

func (m *MessageContext) String() string

func (*MessageContext) XXX_DiscardUnknown

func (m *MessageContext) XXX_DiscardUnknown()

func (*MessageContext) XXX_Marshal

func (m *MessageContext) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MessageContext) XXX_Merge

func (m *MessageContext) XXX_Merge(src proto.Message)

func (*MessageContext) XXX_Size

func (m *MessageContext) XXX_Size() int

func (*MessageContext) XXX_Unmarshal

func (m *MessageContext) XXX_Unmarshal(b []byte) error

type Policy

type Policy struct {
	// The name of the policy.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The time taken for a policy to run.
	TimeTakenNs int64 `protobuf:"varint,2,opt,name=time_taken_ns,json=timeTakenNs,proto3" json:"time_taken_ns,omitempty"`
	// Other properties, flattened. For example, ServiceCallout's target.url and
	// requesturi flow variables will be listed here.
	// https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#servicecallout
	Properties           map[string]*Strings `` /* 161-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

TODO(b/183420583): Add support for Policy objects in the proto conversion. Message representing a Policy. Contains time taken and other miscellaneous properties populated for every policy. https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#apigee

func (*Policy) Descriptor

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

func (*Policy) GetName

func (m *Policy) GetName() string

func (*Policy) GetProperties

func (m *Policy) GetProperties() map[string]*Strings

func (*Policy) GetTimeTakenNs

func (m *Policy) GetTimeTakenNs() int64

func (*Policy) ProtoMessage

func (*Policy) ProtoMessage()

func (*Policy) Reset

func (m *Policy) Reset()

func (*Policy) String

func (m *Policy) String() string

func (*Policy) XXX_DiscardUnknown

func (m *Policy) XXX_DiscardUnknown()

func (*Policy) XXX_Marshal

func (m *Policy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Policy) XXX_Merge

func (m *Policy) XXX_Merge(src proto.Message)

func (*Policy) XXX_Size

func (m *Policy) XXX_Size() int

func (*Policy) XXX_Unmarshal

func (m *Policy) XXX_Unmarshal(b []byte) error

type Proxy

type Proxy struct {
	EndpointName         string   `protobuf:"bytes,1,opt,name=endpoint_name,json=endpointName,proto3" json:"endpoint_name,omitempty"`
	ClientIp             string   `protobuf:"bytes,2,opt,name=client_ip,json=clientIp,proto3" json:"client_ip,omitempty"`
	BasePath             string   `protobuf:"bytes,3,opt,name=base_path,json=basePath,proto3" json:"base_path,omitempty"`
	PathSuffix           string   `protobuf:"bytes,4,opt,name=path_suffix,json=pathSuffix,proto3" json:"path_suffix,omitempty"`
	Url                  string   `protobuf:"bytes,5,opt,name=url,proto3" json:"url,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#proxy

func (*Proxy) Descriptor

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

func (*Proxy) GetBasePath

func (m *Proxy) GetBasePath() string

func (*Proxy) GetClientIp

func (m *Proxy) GetClientIp() string

func (*Proxy) GetEndpointName

func (m *Proxy) GetEndpointName() string

func (*Proxy) GetPathSuffix

func (m *Proxy) GetPathSuffix() string

func (*Proxy) GetUrl

func (m *Proxy) GetUrl() string

func (*Proxy) ProtoMessage

func (*Proxy) ProtoMessage()

func (*Proxy) Reset

func (m *Proxy) Reset()

func (*Proxy) String

func (m *Proxy) String() string

func (*Proxy) XXX_DiscardUnknown

func (m *Proxy) XXX_DiscardUnknown()

func (*Proxy) XXX_Marshal

func (m *Proxy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Proxy) XXX_Merge

func (m *Proxy) XXX_Merge(src proto.Message)

func (*Proxy) XXX_Size

func (m *Proxy) XXX_Size() int

func (*Proxy) XXX_Unmarshal

func (m *Proxy) XXX_Unmarshal(b []byte) error

type Request

type Request struct {
	Uri         string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	Verb        string `protobuf:"bytes,2,opt,name=verb,proto3" json:"verb,omitempty"`
	HttpVersion string `protobuf:"bytes,3,opt,name=http_version,json=httpVersion,proto3" json:"http_version,omitempty"`
	// To remove a header, form param, or query param, set it to
	// Strings.getDefaultInstance().  For example, in text proto,
	// `headers {key: 'h2' value {}}` can be used to remove header "h2".
	// When a header or param exists already, when a different Strings is present
	// in the maps below, the old values will be replaced with the Strings.  For
	// example, to remove Content-Type: application/xml, do
	// requestBuilder.putHeaders("asdf", Strings.getDefaultInstance()).  If the
	// values for header h is 1, 2, and 3, the following will replace the values
	// with 1, 4, 5: headers.putHeaders("h",
	// Strings.newBuilder().addAllStrings("1", "4", "5").build()).
	// What's not presented in the map will not be operated on.
	Headers     map[string]*Strings `` /* 155-byte string literal not displayed */
	FormParams  map[string]*Strings `` /* 179-byte string literal not displayed */
	QueryParams map[string]*Strings `` /* 182-byte string literal not displayed */
	// If content exists, setting this field to empty string will cause the
	// content to be removed.
	//
	// If streaming is enabled on the flow where the ExternalCallout policy is
	// placed, then the content will not be sent to the gRPC server and any
	// modifications performed on this field in the server are ignored. See:
	// https://cloud.google.com/apigee/docs/api-platform/develop/enabling-streaming
	Content              string   `protobuf:"bytes,7,opt,name=content,proto3" json:"content,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Message representing the complete request. https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#request

The following flow variables have been omitted: - formstring, querystring: same as formparams and queryparams - path, URL: can be derived using uri field and target.url field - transportid: always HTTP - transport.message: contains info already listed below (verb, content, etc.)

func (*Request) Descriptor

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

func (*Request) GetContent

func (m *Request) GetContent() string

func (*Request) GetFormParams

func (m *Request) GetFormParams() map[string]*Strings

func (*Request) GetHeaders

func (m *Request) GetHeaders() map[string]*Strings

func (*Request) GetHttpVersion

func (m *Request) GetHttpVersion() string

func (*Request) GetQueryParams

func (m *Request) GetQueryParams() map[string]*Strings

func (*Request) GetUri

func (m *Request) GetUri() string

func (*Request) GetVerb

func (m *Request) GetVerb() string

func (*Request) ProtoMessage

func (*Request) ProtoMessage()

func (*Request) Reset

func (m *Request) Reset()

func (*Request) String

func (m *Request) String() string

func (*Request) XXX_DiscardUnknown

func (m *Request) XXX_DiscardUnknown()

func (*Request) XXX_Marshal

func (m *Request) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Request) XXX_Merge

func (m *Request) XXX_Merge(src proto.Message)

func (*Request) XXX_Size

func (m *Request) XXX_Size() int

func (*Request) XXX_Unmarshal

func (m *Request) XXX_Unmarshal(b []byte) error

type Response

type Response struct {
	StatusCode int32 `protobuf:"varint,1,opt,name=status_code,json=statusCode,proto3" json:"status_code,omitempty"`
	// Examples are OK, Not Found.
	ReasonPhrase string `protobuf:"bytes,2,opt,name=reason_phrase,json=reasonPhrase,proto3" json:"reason_phrase,omitempty"`
	// See the headers field in Request for how to operate on this field.
	Headers map[string]*Strings `` /* 155-byte string literal not displayed */
	// See the content field in Request for how to operate on this field.
	Content              string   `protobuf:"bytes,4,opt,name=content,proto3" json:"content,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Message representing the complete response. https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#response

The following variables have been omitted: - transport.message: contains info already listed below (code, content, etc) - formparams: invalid field that only exists for requests, not responses

func (*Response) Descriptor

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

func (*Response) GetContent

func (m *Response) GetContent() string

func (*Response) GetHeaders

func (m *Response) GetHeaders() map[string]*Strings

func (*Response) GetReasonPhrase

func (m *Response) GetReasonPhrase() string

func (*Response) GetStatusCode

func (m *Response) GetStatusCode() int32

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) Reset

func (m *Response) Reset()

func (*Response) String

func (m *Response) String() string

func (*Response) XXX_DiscardUnknown

func (m *Response) XXX_DiscardUnknown()

func (*Response) XXX_Marshal

func (m *Response) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Response) XXX_Merge

func (m *Response) XXX_Merge(src proto.Message)

func (*Response) XXX_Size

func (m *Response) XXX_Size() int

func (*Response) XXX_Unmarshal

func (m *Response) XXX_Unmarshal(b []byte) error

type Route

type Route struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Target               string   `protobuf:"bytes,2,opt,name=target,proto3" json:"target,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#route

func (*Route) Descriptor

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

func (*Route) GetName

func (m *Route) GetName() string

func (*Route) GetTarget

func (m *Route) GetTarget() string

func (*Route) ProtoMessage

func (*Route) ProtoMessage()

func (*Route) Reset

func (m *Route) Reset()

func (*Route) String

func (m *Route) String() string

func (*Route) XXX_DiscardUnknown

func (m *Route) XXX_DiscardUnknown()

func (*Route) XXX_Marshal

func (m *Route) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Route) XXX_Merge

func (m *Route) XXX_Merge(src proto.Message)

func (*Route) XXX_Size

func (m *Route) XXX_Size() int

func (*Route) XXX_Unmarshal

func (m *Route) XXX_Unmarshal(b []byte) error

type Strings

type Strings struct {
	Strings              []string `protobuf:"bytes,1,rep,name=strings,proto3" json:"strings,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Strings) Descriptor

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

func (*Strings) GetStrings

func (m *Strings) GetStrings() []string

func (*Strings) ProtoMessage

func (*Strings) ProtoMessage()

func (*Strings) Reset

func (m *Strings) Reset()

func (*Strings) String

func (m *Strings) String() string

func (*Strings) XXX_DiscardUnknown

func (m *Strings) XXX_DiscardUnknown()

func (*Strings) XXX_Marshal

func (m *Strings) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Strings) XXX_Merge

func (m *Strings) XXX_Merge(src proto.Message)

func (*Strings) XXX_Size

func (m *Strings) XXX_Size() int

func (*Strings) XXX_Unmarshal

func (m *Strings) XXX_Unmarshal(b []byte) error

type Target

type Target struct {
	BasePath             string   `protobuf:"bytes,1,opt,name=base_path,json=basePath,proto3" json:"base_path,omitempty"`
	CopyPathSuffix       bool     `protobuf:"varint,2,opt,name=copy_path_suffix,json=copyPathSuffix,proto3" json:"copy_path_suffix,omitempty"`
	CopyQueryParams      bool     `protobuf:"varint,3,opt,name=copy_query_params,json=copyQueryParams,proto3" json:"copy_query_params,omitempty"`
	Country              string   `protobuf:"bytes,4,opt,name=country,proto3" json:"country,omitempty"`
	Cn                   string   `protobuf:"bytes,5,opt,name=cn,proto3" json:"cn,omitempty"`
	EmailAddress         string   `protobuf:"bytes,6,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"`
	ExpectedCn           string   `protobuf:"bytes,7,opt,name=expected_cn,json=expectedCn,proto3" json:"expected_cn,omitempty"`
	Host                 string   `protobuf:"bytes,8,opt,name=host,proto3" json:"host,omitempty"`
	Ip                   string   `protobuf:"bytes,9,opt,name=ip,proto3" json:"ip,omitempty"`
	Locality             string   `protobuf:"bytes,10,opt,name=locality,proto3" json:"locality,omitempty"`
	Name                 string   `protobuf:"bytes,11,opt,name=name,proto3" json:"name,omitempty"`
	Organization         string   `protobuf:"bytes,12,opt,name=organization,proto3" json:"organization,omitempty"`
	OrganizationUnit     string   `protobuf:"bytes,13,opt,name=organization_unit,json=organizationUnit,proto3" json:"organization_unit,omitempty"`
	Port                 int32    `protobuf:"varint,14,opt,name=port,proto3" json:"port,omitempty"`
	Scheme               string   `protobuf:"bytes,15,opt,name=scheme,proto3" json:"scheme,omitempty"`
	State                string   `protobuf:"bytes,16,opt,name=state,proto3" json:"state,omitempty"`
	SslEnabled           bool     `protobuf:"varint,17,opt,name=ssl_enabled,json=sslEnabled,proto3" json:"ssl_enabled,omitempty"`
	Url                  string   `protobuf:"bytes,18,opt,name=url,proto3" json:"url,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

https://cloud.google.com/apigee/docs/api-platform/reference/variables-reference#target

func (*Target) Descriptor

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

func (*Target) GetBasePath

func (m *Target) GetBasePath() string

func (*Target) GetCn

func (m *Target) GetCn() string

func (*Target) GetCopyPathSuffix

func (m *Target) GetCopyPathSuffix() bool

func (*Target) GetCopyQueryParams

func (m *Target) GetCopyQueryParams() bool

func (*Target) GetCountry

func (m *Target) GetCountry() string

func (*Target) GetEmailAddress

func (m *Target) GetEmailAddress() string

func (*Target) GetExpectedCn

func (m *Target) GetExpectedCn() string

func (*Target) GetHost

func (m *Target) GetHost() string

func (*Target) GetIp

func (m *Target) GetIp() string

func (*Target) GetLocality

func (m *Target) GetLocality() string

func (*Target) GetName

func (m *Target) GetName() string

func (*Target) GetOrganization

func (m *Target) GetOrganization() string

func (*Target) GetOrganizationUnit

func (m *Target) GetOrganizationUnit() string

func (*Target) GetPort

func (m *Target) GetPort() int32

func (*Target) GetScheme

func (m *Target) GetScheme() string

func (*Target) GetSslEnabled

func (m *Target) GetSslEnabled() bool

func (*Target) GetState

func (m *Target) GetState() string

func (*Target) GetUrl

func (m *Target) GetUrl() string

func (*Target) ProtoMessage

func (*Target) ProtoMessage()

func (*Target) Reset

func (m *Target) Reset()

func (*Target) String

func (m *Target) String() string

func (*Target) XXX_DiscardUnknown

func (m *Target) XXX_DiscardUnknown()

func (*Target) XXX_Marshal

func (m *Target) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Target) XXX_Merge

func (m *Target) XXX_Merge(src proto.Message)

func (*Target) XXX_Size

func (m *Target) XXX_Size() int

func (*Target) XXX_Unmarshal

func (m *Target) XXX_Unmarshal(b []byte) error

type UnimplementedExternalCalloutServiceServer

type UnimplementedExternalCalloutServiceServer struct {
}

UnimplementedExternalCalloutServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedExternalCalloutServiceServer) ProcessMessage

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL