v2

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_control_plane_v2_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type DataPlaneRegion

type DataPlaneRegion struct {
	Name           string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Url            string   `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	Lat            float64  `protobuf:"fixed64,3,opt,name=lat,proto3" json:"lat,omitempty"`
	Lon            float64  `protobuf:"fixed64,4,opt,name=lon,proto3" json:"lon,omitempty"`
	Region         string   `protobuf:"bytes,5,opt,name=region,proto3" json:"region,omitempty"`
	Labels         []string `protobuf:"bytes,6,rep,name=labels,proto3" json:"labels,omitempty"`
	DefaultPrimary bool     `protobuf:"varint,7,opt,name=default_primary,json=defaultPrimary,proto3" json:"default_primary,omitempty"`
	DefaultBackup  bool     `protobuf:"varint,8,opt,name=default_backup,json=defaultBackup,proto3" json:"default_backup,omitempty"`
	Status         string   `protobuf:"bytes,9,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

A description of a Data Plane api region

func (*DataPlaneRegion) Descriptor deprecated

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

Deprecated: Use DataPlaneRegion.ProtoReflect.Descriptor instead.

func (*DataPlaneRegion) GetDefaultBackup

func (x *DataPlaneRegion) GetDefaultBackup() bool

func (*DataPlaneRegion) GetDefaultPrimary

func (x *DataPlaneRegion) GetDefaultPrimary() bool

func (*DataPlaneRegion) GetLabels

func (x *DataPlaneRegion) GetLabels() []string

func (*DataPlaneRegion) GetLat

func (x *DataPlaneRegion) GetLat() float64

func (*DataPlaneRegion) GetLon

func (x *DataPlaneRegion) GetLon() float64

func (*DataPlaneRegion) GetName

func (x *DataPlaneRegion) GetName() string

func (*DataPlaneRegion) GetRegion

func (x *DataPlaneRegion) GetRegion() string

func (*DataPlaneRegion) GetStatus

func (x *DataPlaneRegion) GetStatus() string

func (*DataPlaneRegion) GetUrl

func (x *DataPlaneRegion) GetUrl() string

func (*DataPlaneRegion) ProtoMessage

func (*DataPlaneRegion) ProtoMessage()

func (*DataPlaneRegion) ProtoReflect

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

func (*DataPlaneRegion) Reset

func (x *DataPlaneRegion) Reset()

func (*DataPlaneRegion) String

func (x *DataPlaneRegion) String() string

func (*DataPlaneRegion) Validate

func (m *DataPlaneRegion) Validate() error

Validate checks the field values on DataPlaneRegion with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DataPlaneRegion) ValidateAll

func (m *DataPlaneRegion) ValidateAll() error

ValidateAll checks the field values on DataPlaneRegion with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DataPlaneRegionMultiError, or nil if none found.

type DataPlaneRegionMultiError

type DataPlaneRegionMultiError []error

DataPlaneRegionMultiError is an error wrapping multiple validation errors returned by DataPlaneRegion.ValidateAll() if the designated constraints aren't met.

func (DataPlaneRegionMultiError) AllErrors

func (m DataPlaneRegionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DataPlaneRegionMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type DataPlaneRegionValidationError

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

DataPlaneRegionValidationError is the validation error returned by DataPlaneRegion.Validate if the designated constraints aren't met.

func (DataPlaneRegionValidationError) Cause

Cause function returns cause value.

func (DataPlaneRegionValidationError) Error

Error satisfies the builtin error interface

func (DataPlaneRegionValidationError) ErrorName

func (e DataPlaneRegionValidationError) ErrorName() string

ErrorName returns error name.

func (DataPlaneRegionValidationError) Field

Field function returns field value.

func (DataPlaneRegionValidationError) Key

Key function returns key value.

func (DataPlaneRegionValidationError) Reason

Reason function returns reason value.

type DataRegionsListResponse

type DataRegionsListResponse struct {
	Regions []*DataPlaneRegion `protobuf:"bytes,1,rep,name=regions,proto3" json:"regions,omitempty"`
	// contains filtered or unexported fields
}

The list of data plane regions

Response to GET "/regions"

func (*DataRegionsListResponse) Descriptor deprecated

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

Deprecated: Use DataRegionsListResponse.ProtoReflect.Descriptor instead.

func (*DataRegionsListResponse) GetRegions

func (x *DataRegionsListResponse) GetRegions() []*DataPlaneRegion

func (*DataRegionsListResponse) ProtoMessage

func (*DataRegionsListResponse) ProtoMessage()

func (*DataRegionsListResponse) ProtoReflect

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

func (*DataRegionsListResponse) Reset

func (x *DataRegionsListResponse) Reset()

func (*DataRegionsListResponse) String

func (x *DataRegionsListResponse) String() string

func (*DataRegionsListResponse) Validate

func (m *DataRegionsListResponse) Validate() error

Validate checks the field values on DataRegionsListResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DataRegionsListResponse) ValidateAll

func (m *DataRegionsListResponse) ValidateAll() error

ValidateAll checks the field values on DataRegionsListResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DataRegionsListResponseMultiError, or nil if none found.

type DataRegionsListResponseMultiError

type DataRegionsListResponseMultiError []error

DataRegionsListResponseMultiError is an error wrapping multiple validation errors returned by DataRegionsListResponse.ValidateAll() if the designated constraints aren't met.

func (DataRegionsListResponseMultiError) AllErrors

func (m DataRegionsListResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DataRegionsListResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type DataRegionsListResponseValidationError

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

DataRegionsListResponseValidationError is the validation error returned by DataRegionsListResponse.Validate if the designated constraints aren't met.

func (DataRegionsListResponseValidationError) Cause

Cause function returns cause value.

func (DataRegionsListResponseValidationError) Error

Error satisfies the builtin error interface

func (DataRegionsListResponseValidationError) ErrorName

ErrorName returns error name.

func (DataRegionsListResponseValidationError) Field

Field function returns field value.

func (DataRegionsListResponseValidationError) Key

Key function returns key value.

func (DataRegionsListResponseValidationError) Reason

Reason function returns reason value.

type DataRegionsLocateResponse

type DataRegionsLocateResponse struct {
	PrimaryUrl        string `protobuf:"bytes,1,opt,name=primary_url,json=primaryUrl,proto3" json:"primary_url,omitempty"`
	BackupUrl         string `protobuf:"bytes,2,opt,name=backup_url,json=backupUrl,proto3" json:"backup_url,omitempty"`
	PrimaryNetworkUrl string `protobuf:"bytes,3,opt,name=primary_network_url,json=primaryNetworkUrl,proto3" json:"primary_network_url,omitempty"`
	BackupNetworkUrl  string `protobuf:"bytes,4,opt,name=backup_network_url,json=backupNetworkUrl,proto3" json:"backup_network_url,omitempty"`
	// contains filtered or unexported fields
}

The primary and backup urls for the closest data plane regions to a user

Response for GET "/regions/locate"

func (*DataRegionsLocateResponse) Descriptor deprecated

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

Deprecated: Use DataRegionsLocateResponse.ProtoReflect.Descriptor instead.

func (*DataRegionsLocateResponse) GetBackupNetworkUrl

func (x *DataRegionsLocateResponse) GetBackupNetworkUrl() string

func (*DataRegionsLocateResponse) GetBackupUrl

func (x *DataRegionsLocateResponse) GetBackupUrl() string

func (*DataRegionsLocateResponse) GetPrimaryNetworkUrl

func (x *DataRegionsLocateResponse) GetPrimaryNetworkUrl() string

func (*DataRegionsLocateResponse) GetPrimaryUrl

func (x *DataRegionsLocateResponse) GetPrimaryUrl() string

func (*DataRegionsLocateResponse) ProtoMessage

func (*DataRegionsLocateResponse) ProtoMessage()

func (*DataRegionsLocateResponse) ProtoReflect

func (*DataRegionsLocateResponse) Reset

func (x *DataRegionsLocateResponse) Reset()

func (*DataRegionsLocateResponse) String

func (x *DataRegionsLocateResponse) String() string

func (*DataRegionsLocateResponse) Validate

func (m *DataRegionsLocateResponse) Validate() error

Validate checks the field values on DataRegionsLocateResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DataRegionsLocateResponse) ValidateAll

func (m *DataRegionsLocateResponse) ValidateAll() error

ValidateAll checks the field values on DataRegionsLocateResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DataRegionsLocateResponseMultiError, or nil if none found.

type DataRegionsLocateResponseMultiError

type DataRegionsLocateResponseMultiError []error

DataRegionsLocateResponseMultiError is an error wrapping multiple validation errors returned by DataRegionsLocateResponse.ValidateAll() if the designated constraints aren't met.

func (DataRegionsLocateResponseMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (DataRegionsLocateResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type DataRegionsLocateResponseValidationError

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

DataRegionsLocateResponseValidationError is the validation error returned by DataRegionsLocateResponse.Validate if the designated constraints aren't met.

func (DataRegionsLocateResponseValidationError) Cause

Cause function returns cause value.

func (DataRegionsLocateResponseValidationError) Error

Error satisfies the builtin error interface

func (DataRegionsLocateResponseValidationError) ErrorName

ErrorName returns error name.

func (DataRegionsLocateResponseValidationError) Field

Field function returns field value.

func (DataRegionsLocateResponseValidationError) Key

Key function returns key value.

func (DataRegionsLocateResponseValidationError) Reason

Reason function returns reason value.

type RevokeAppTokenRequest

type RevokeAppTokenRequest struct {
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

Revoke Token request to invalidate previously created tokens for a specific use. Invalidates Strict mode tokens.

Request for POST "/tokens/revoke"

func (*RevokeAppTokenRequest) Descriptor deprecated

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

Deprecated: Use RevokeAppTokenRequest.ProtoReflect.Descriptor instead.

func (*RevokeAppTokenRequest) GetUserId

func (x *RevokeAppTokenRequest) GetUserId() string

func (*RevokeAppTokenRequest) ProtoMessage

func (*RevokeAppTokenRequest) ProtoMessage()

func (*RevokeAppTokenRequest) ProtoReflect

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

func (*RevokeAppTokenRequest) Reset

func (x *RevokeAppTokenRequest) Reset()

func (*RevokeAppTokenRequest) String

func (x *RevokeAppTokenRequest) String() string

func (*RevokeAppTokenRequest) Validate

func (m *RevokeAppTokenRequest) Validate() error

Validate checks the field values on RevokeAppTokenRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RevokeAppTokenRequest) ValidateAll

func (m *RevokeAppTokenRequest) ValidateAll() error

ValidateAll checks the field values on RevokeAppTokenRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RevokeAppTokenRequestMultiError, or nil if none found.

type RevokeAppTokenRequestMultiError

type RevokeAppTokenRequestMultiError []error

RevokeAppTokenRequestMultiError is an error wrapping multiple validation errors returned by RevokeAppTokenRequest.ValidateAll() if the designated constraints aren't met.

func (RevokeAppTokenRequestMultiError) AllErrors

func (m RevokeAppTokenRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RevokeAppTokenRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type RevokeAppTokenRequestValidationError

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

RevokeAppTokenRequestValidationError is the validation error returned by RevokeAppTokenRequest.Validate if the designated constraints aren't met.

func (RevokeAppTokenRequestValidationError) Cause

Cause function returns cause value.

func (RevokeAppTokenRequestValidationError) Error

Error satisfies the builtin error interface

func (RevokeAppTokenRequestValidationError) ErrorName

ErrorName returns error name.

func (RevokeAppTokenRequestValidationError) Field

Field function returns field value.

func (RevokeAppTokenRequestValidationError) Key

Key function returns key value.

func (RevokeAppTokenRequestValidationError) Reason

Reason function returns reason value.

type TokenUpgradeRequest

type TokenUpgradeRequest struct {
	PublicToken string `protobuf:"bytes,1,opt,name=public_token,json=publicToken,proto3" json:"public_token,omitempty"`
	// The authenticated user_id to attach to captured data.
	// This should be validated by the customer backend.
	// DO NOT pass if using a public token for Authorization
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The duration the token is valid expressed in seconds.
	// May be capped to a maximum by backend token upgrade
	// handlers.
	ExpiresInSeconds   int32 `protobuf:"varint,3,opt,name=expires_in_seconds,json=expiresInSeconds,proto3" json:"expires_in_seconds,omitempty"`
	MaxIdleTimeMinutes int32 `protobuf:"varint,4,opt,name=max_idle_time_minutes,json=maxIdleTimeMinutes,proto3" json:"max_idle_time_minutes,omitempty"`
	// contains filtered or unexported fields
}

The request body for upgrading a Public Token to a Permissive Token or a User Authenticated (Strict) Token. The UserId can only be set by making the request with a SecretToken in the Authorization Header. If using the PublicToken, DO NOT pass the UserId.

Performing this request for a Strict Token means that a UserId will be tracked against Bundles sent using the returned token

Request for POST "/tokens/upgrade"

func (*TokenUpgradeRequest) Descriptor deprecated

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

Deprecated: Use TokenUpgradeRequest.ProtoReflect.Descriptor instead.

func (*TokenUpgradeRequest) GetExpiresInSeconds

func (x *TokenUpgradeRequest) GetExpiresInSeconds() int32

func (*TokenUpgradeRequest) GetMaxIdleTimeMinutes

func (x *TokenUpgradeRequest) GetMaxIdleTimeMinutes() int32

func (*TokenUpgradeRequest) GetPublicToken

func (x *TokenUpgradeRequest) GetPublicToken() string

func (*TokenUpgradeRequest) GetUserId

func (x *TokenUpgradeRequest) GetUserId() string

func (*TokenUpgradeRequest) ProtoMessage

func (*TokenUpgradeRequest) ProtoMessage()

func (*TokenUpgradeRequest) ProtoReflect

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

func (*TokenUpgradeRequest) Reset

func (x *TokenUpgradeRequest) Reset()

func (*TokenUpgradeRequest) String

func (x *TokenUpgradeRequest) String() string

func (*TokenUpgradeRequest) Validate

func (m *TokenUpgradeRequest) Validate() error

Validate checks the field values on TokenUpgradeRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*TokenUpgradeRequest) ValidateAll

func (m *TokenUpgradeRequest) ValidateAll() error

ValidateAll checks the field values on TokenUpgradeRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TokenUpgradeRequestMultiError, or nil if none found.

type TokenUpgradeRequestMultiError

type TokenUpgradeRequestMultiError []error

TokenUpgradeRequestMultiError is an error wrapping multiple validation errors returned by TokenUpgradeRequest.ValidateAll() if the designated constraints aren't met.

func (TokenUpgradeRequestMultiError) AllErrors

func (m TokenUpgradeRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TokenUpgradeRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type TokenUpgradeRequestValidationError

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

TokenUpgradeRequestValidationError is the validation error returned by TokenUpgradeRequest.Validate if the designated constraints aren't met.

func (TokenUpgradeRequestValidationError) Cause

Cause function returns cause value.

func (TokenUpgradeRequestValidationError) Error

Error satisfies the builtin error interface

func (TokenUpgradeRequestValidationError) ErrorName

ErrorName returns error name.

func (TokenUpgradeRequestValidationError) Field

Field function returns field value.

func (TokenUpgradeRequestValidationError) Key

Key function returns key value.

func (TokenUpgradeRequestValidationError) Reason

Reason function returns reason value.

type TokenUpgradeResponse

type TokenUpgradeResponse struct {
	AppAccessToken string `protobuf:"bytes,1,opt,name=app_access_token,json=appAccessToken,proto3" json:"app_access_token,omitempty"`
	// contains filtered or unexported fields
}

An app access token with a a customer authenticated UserId attached.

Response for POST "/tokens/upgrade"

func (*TokenUpgradeResponse) Descriptor deprecated

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

Deprecated: Use TokenUpgradeResponse.ProtoReflect.Descriptor instead.

func (*TokenUpgradeResponse) GetAppAccessToken

func (x *TokenUpgradeResponse) GetAppAccessToken() string

func (*TokenUpgradeResponse) ProtoMessage

func (*TokenUpgradeResponse) ProtoMessage()

func (*TokenUpgradeResponse) ProtoReflect

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

func (*TokenUpgradeResponse) Reset

func (x *TokenUpgradeResponse) Reset()

func (*TokenUpgradeResponse) String

func (x *TokenUpgradeResponse) String() string

func (*TokenUpgradeResponse) Validate

func (m *TokenUpgradeResponse) Validate() error

Validate checks the field values on TokenUpgradeResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*TokenUpgradeResponse) ValidateAll

func (m *TokenUpgradeResponse) ValidateAll() error

ValidateAll checks the field values on TokenUpgradeResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TokenUpgradeResponseMultiError, or nil if none found.

type TokenUpgradeResponseMultiError

type TokenUpgradeResponseMultiError []error

TokenUpgradeResponseMultiError is an error wrapping multiple validation errors returned by TokenUpgradeResponse.ValidateAll() if the designated constraints aren't met.

func (TokenUpgradeResponseMultiError) AllErrors

func (m TokenUpgradeResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TokenUpgradeResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type TokenUpgradeResponseValidationError

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

TokenUpgradeResponseValidationError is the validation error returned by TokenUpgradeResponse.Validate if the designated constraints aren't met.

func (TokenUpgradeResponseValidationError) Cause

Cause function returns cause value.

func (TokenUpgradeResponseValidationError) Error

Error satisfies the builtin error interface

func (TokenUpgradeResponseValidationError) ErrorName

ErrorName returns error name.

func (TokenUpgradeResponseValidationError) Field

Field function returns field value.

func (TokenUpgradeResponseValidationError) Key

Key function returns key value.

func (TokenUpgradeResponseValidationError) Reason

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL