apigatewaydata

package
v0.9.0 Latest Latest
Warning

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

 Go to latest Published: Sep 26, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package apigatewaydata provides API Gateway type definitions for CloudEvent data payloads.

Supported CloudEvent Types

  • google.cloud.apigateway.gateway.v1.created
  • google.cloud.apigateway.gateway.v1.updated
  • google.cloud.apigateway.gateway.v1.deleted
  • google.cloud.apigateway.api.v1.created
  • google.cloud.apigateway.api.v1.updated
  • google.cloud.apigateway.api.v1.deleted
  • google.cloud.apigateway.apiConfig.v1.created
  • google.cloud.apigateway.apiConfig.v1.updated
  • google.cloud.apigateway.apiConfig.v1.deleted

Index

Constants

This section is empty.

Variables

View Source 
var (
	Api_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "FAILED",
		4: "DELETING",
		5: "UPDATING",
	}
	Api_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"ACTIVE":            2,
		"FAILED":            3,
		"DELETING":          4,
		"UPDATING":          5,
	}
)

Enum value maps for Api_State.

View Source 
var (
	ApiConfig_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "FAILED",
		4: "DELETING",
		5: "UPDATING",
		6: "ACTIVATING",
	}
	ApiConfig_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"ACTIVE":            2,
		"FAILED":            3,
		"DELETING":          4,
		"UPDATING":          5,
		"ACTIVATING":        6,
	}
)

Enum value maps for ApiConfig_State.

View Source 
var (
	Gateway_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "FAILED",
		4: "DELETING",
		5: "UPDATING",
	}
	Gateway_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"ACTIVE":            2,
		"FAILED":            3,
		"DELETING":          4,
		"UPDATING":          5,
	}
)

Enum value maps for Gateway_State.

View Source 
var File_cloud_apigateway_v1_data_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Api 

type Api struct {

	// Output only. Resource name of the API.
	// Format: projects/{project}/locations/global/apis/{api}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Created time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Updated time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Resource labels to represent user-provided metadata.
	// Refer to cloud documentation on labels for more details.
	// https://cloud.google.com/compute/docs/labeling-resources
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Optional. Display name.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. Immutable. The name of a Google Managed Service (
	// https://cloud.google.com/service-infrastructure/docs/glossary#managed).
	// If not specified, a new Service will automatically be created in the same
	// project as this API.
	ManagedService string `protobuf:"bytes,7,opt,name=managed_service,json=managedService,proto3" json:"managed_service,omitempty"`
	// Output only. State of the API.
	State Api_State `protobuf:"varint,12,opt,name=state,proto3,enum=google.events.cloud.apigateway.v1.Api_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

An API that can be served by one or more Gateways.

func (*Api) Descriptor deprecated 

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

Deprecated: Use Api.ProtoReflect.Descriptor instead.

func (*Api) GetCreateTime 

func (x *Api) GetCreateTime() *timestamppb.Timestamp

func (*Api) GetDisplayName 

func (x *Api) GetDisplayName() string

func (*Api) GetLabels 

func (x *Api) GetLabels() map[string]string

func (*Api) GetManagedService 

func (x *Api) GetManagedService() string

func (*Api) GetName 

func (x *Api) GetName() string

func (*Api) GetState 

func (x *Api) GetState() Api_State

func (*Api) GetUpdateTime 

func (x *Api) GetUpdateTime() *timestamppb.Timestamp

func (*Api) ProtoMessage 

func (*Api) ProtoMessage()

func (*Api) ProtoReflect 

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

func (*Api) Reset 

func (x *Api) Reset()

func (*Api) String 

func (x *Api) String() string

type ApiConfig 

type ApiConfig struct {

	// Output only. Resource name of the API Config.
	// Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Created time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Updated time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Resource labels to represent user-provided metadata.
	// Refer to cloud documentation on labels for more details.
	// https://cloud.google.com/compute/docs/labeling-resources
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Optional. Display name.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Immutable. The Google Cloud IAM Service Account that Gateways serving this
	// config should use to authenticate to other services. This may either be the
	// Service Account's email
	// (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource
	// name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used
	// when the service is a GCP resource such as a Cloud Run Service or an
	// IAP-secured service.
	GatewayServiceAccount string `` /* 127-byte string literal not displayed */
	// Output only. The ID of the associated Service Config (
	// https://cloud.google.com/service-infrastructure/docs/glossary#config).
	ServiceConfigId string `protobuf:"bytes,12,opt,name=service_config_id,json=serviceConfigId,proto3" json:"service_config_id,omitempty"`
	// Output only. State of the API Config.
	State ApiConfig_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.events.cloud.apigateway.v1.ApiConfig_State" json:"state,omitempty"`
	// Optional. OpenAPI specification documents. If specified, grpc_services and
	// managed_service_configs must not be included.
	OpenapiDocuments []*ApiConfig_OpenApiDocument `protobuf:"bytes,9,rep,name=openapi_documents,json=openapiDocuments,proto3" json:"openapi_documents,omitempty"`
	// Optional. gRPC service definition files. If specified, openapi_documents
	// must not be included.
	GrpcServices []*ApiConfig_GrpcServiceDefinition `protobuf:"bytes,10,rep,name=grpc_services,json=grpcServices,proto3" json:"grpc_services,omitempty"`
	// Optional. Service Configuration files. At least one must be included when
	// using gRPC service definitions. See
	// https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview
	// for the expected file contents.
	//
	// If multiple files are specified, the files are merged with the following
	// rules:
	// * All singular scalar fields are merged using "last one wins" semantics in
	// the order of the files uploaded.
	// * Repeated fields are concatenated.
	// * Singular embedded messages are merged using these rules for nested
	// fields.
	ManagedServiceConfigs []*ApiConfig_File `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

func (*ApiConfig) Descriptor deprecated 

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

Deprecated: Use ApiConfig.ProtoReflect.Descriptor instead.

func (*ApiConfig) GetCreateTime 

func (x *ApiConfig) GetCreateTime() *timestamppb.Timestamp

func (*ApiConfig) GetDisplayName 

func (x *ApiConfig) GetDisplayName() string

func (*ApiConfig) GetGatewayServiceAccount 

func (x *ApiConfig) GetGatewayServiceAccount() string

func (*ApiConfig) GetGrpcServices 

func (x *ApiConfig) GetGrpcServices() []*ApiConfig_GrpcServiceDefinition

func (*ApiConfig) GetLabels 

func (x *ApiConfig) GetLabels() map[string]string

func (*ApiConfig) GetManagedServiceConfigs 

func (x *ApiConfig) GetManagedServiceConfigs() []*ApiConfig_File

func (*ApiConfig) GetName 

func (x *ApiConfig) GetName() string

func (*ApiConfig) GetOpenapiDocuments 

func (x *ApiConfig) GetOpenapiDocuments() []*ApiConfig_OpenApiDocument

func (*ApiConfig) GetServiceConfigId 

func (x *ApiConfig) GetServiceConfigId() string

func (*ApiConfig) GetState 

func (x *ApiConfig) GetState() ApiConfig_State

func (*ApiConfig) GetUpdateTime 

func (x *ApiConfig) GetUpdateTime() *timestamppb.Timestamp

func (*ApiConfig) ProtoMessage 

func (*ApiConfig) ProtoMessage()

func (*ApiConfig) ProtoReflect 

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

func (*ApiConfig) Reset 

func (x *ApiConfig) Reset()

func (*ApiConfig) String 

func (x *ApiConfig) String() string

type ApiConfigEventData 

type ApiConfigEventData struct {

	// Optional. The ApiConfig event payload. Unset for deletion events.
	Payload *ApiConfig `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all ApiConfig events.

func (*ApiConfigEventData) Descriptor deprecated 

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

Deprecated: Use ApiConfigEventData.ProtoReflect.Descriptor instead.

func (*ApiConfigEventData) GetPayload 

func (x *ApiConfigEventData) GetPayload() *ApiConfig

func (*ApiConfigEventData) ProtoMessage 

func (*ApiConfigEventData) ProtoMessage()

func (*ApiConfigEventData) ProtoReflect 

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

func (*ApiConfigEventData) Reset 

func (x *ApiConfigEventData) Reset()

func (*ApiConfigEventData) String 

func (x *ApiConfigEventData) String() string

type ApiConfig_File 

type ApiConfig_File struct {

	// The file path (full or relative path). This is typically the path of the
	// file when it is uploaded.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// The bytes that constitute the file.
	Contents []byte `protobuf:"bytes,2,opt,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

A lightweight description of a file.

func (*ApiConfig_File) Descriptor deprecated 

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

Deprecated: Use ApiConfig_File.ProtoReflect.Descriptor instead.

func (*ApiConfig_File) GetContents 

func (x *ApiConfig_File) GetContents() []byte

func (*ApiConfig_File) GetPath 

func (x *ApiConfig_File) GetPath() string

func (*ApiConfig_File) ProtoMessage 

func (*ApiConfig_File) ProtoMessage()

func (*ApiConfig_File) ProtoReflect 

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

func (*ApiConfig_File) Reset 

func (x *ApiConfig_File) Reset()

func (*ApiConfig_File) String 

func (x *ApiConfig_File) String() string

type ApiConfig_GrpcServiceDefinition 

type ApiConfig_GrpcServiceDefinition struct {

	// Optional. Uncompiled proto files associated with the descriptor set, used
	// for display purposes (server-side compilation is not supported). These
	// should match the inputs to 'protoc' command used to generate
	// file_descriptor_set.
	Source []*ApiConfig_File `protobuf:"bytes,2,rep,name=source,proto3" json:"source,omitempty"`
	// contains filtered or unexported fields
}

A gRPC service definition.

func (*ApiConfig_GrpcServiceDefinition) Descriptor deprecated 

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

Deprecated: Use ApiConfig_GrpcServiceDefinition.ProtoReflect.Descriptor instead.

func (*ApiConfig_GrpcServiceDefinition) GetSource 

func (x *ApiConfig_GrpcServiceDefinition) GetSource() []*ApiConfig_File

func (*ApiConfig_GrpcServiceDefinition) ProtoMessage 

func (*ApiConfig_GrpcServiceDefinition) ProtoMessage()

func (*ApiConfig_GrpcServiceDefinition) ProtoReflect 

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

func (*ApiConfig_GrpcServiceDefinition) Reset 

func (x *ApiConfig_GrpcServiceDefinition) Reset()

func (*ApiConfig_GrpcServiceDefinition) String 

func (x *ApiConfig_GrpcServiceDefinition) String() string

type ApiConfig_OpenApiDocument 

type ApiConfig_OpenApiDocument struct {

	// The OpenAPI Specification document file.
	Document *ApiConfig_File `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

An OpenAPI Specification Document describing an API.

func (*ApiConfig_OpenApiDocument) Descriptor deprecated 

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

Deprecated: Use ApiConfig_OpenApiDocument.ProtoReflect.Descriptor instead.

func (*ApiConfig_OpenApiDocument) GetDocument 

func (x *ApiConfig_OpenApiDocument) GetDocument() *ApiConfig_File

func (*ApiConfig_OpenApiDocument) ProtoMessage 

func (*ApiConfig_OpenApiDocument) ProtoMessage()

func (*ApiConfig_OpenApiDocument) ProtoReflect 

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

func (*ApiConfig_OpenApiDocument) Reset 

func (x *ApiConfig_OpenApiDocument) Reset()

func (*ApiConfig_OpenApiDocument) String 

func (x *ApiConfig_OpenApiDocument) String() string

type ApiConfig_State 

type ApiConfig_State int32

All the possible API Config states. 

const (
	// API Config does not have a state yet.
	ApiConfig_STATE_UNSPECIFIED ApiConfig_State = 0
	// API Config is being created and deployed to the API Controller.
	ApiConfig_CREATING ApiConfig_State = 1
	// API Config is ready for use by Gateways.
	ApiConfig_ACTIVE ApiConfig_State = 2
	// API Config creation failed.
	ApiConfig_FAILED ApiConfig_State = 3
	// API Config is being deleted.
	ApiConfig_DELETING ApiConfig_State = 4
	// API Config is being updated.
	ApiConfig_UPDATING ApiConfig_State = 5
	// API Config settings are being activated in downstream systems.
	// API Configs in this state cannot be used by Gateways.
	ApiConfig_ACTIVATING ApiConfig_State = 6
)

func (ApiConfig_State) Descriptor 

func (ApiConfig_State) Descriptor() protoreflect.EnumDescriptor

func (ApiConfig_State) Enum 

func (x ApiConfig_State) Enum() *ApiConfig_State

func (ApiConfig_State) EnumDescriptor deprecated 

func (ApiConfig_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use ApiConfig_State.Descriptor instead.

func (ApiConfig_State) Number 

func (x ApiConfig_State) Number() protoreflect.EnumNumber

func (ApiConfig_State) String 

func (x ApiConfig_State) String() string

func (ApiConfig_State) Type 

func (ApiConfig_State) Type() protoreflect.EnumType

type ApiEventData 

type ApiEventData struct {

	// Optional. The Api event payload. Unset for deletion events.
	Payload *Api `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Api events.

func (*ApiEventData) Descriptor deprecated 

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

Deprecated: Use ApiEventData.ProtoReflect.Descriptor instead.

func (*ApiEventData) GetPayload 

func (x *ApiEventData) GetPayload() *Api

func (*ApiEventData) ProtoMessage 

func (*ApiEventData) ProtoMessage()

func (*ApiEventData) ProtoReflect 

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

func (*ApiEventData) Reset 

func (x *ApiEventData) Reset()

func (*ApiEventData) String 

func (x *ApiEventData) String() string

type Api_State 

type Api_State int32

All the possible API states. 

const (
	// API does not have a state yet.
	Api_STATE_UNSPECIFIED Api_State = 0
	// API is being created.
	Api_CREATING Api_State = 1
	// API is active.
	Api_ACTIVE Api_State = 2
	// API creation failed.
	Api_FAILED Api_State = 3
	// API is being deleted.
	Api_DELETING Api_State = 4
	// API is being updated.
	Api_UPDATING Api_State = 5
)

func (Api_State) Descriptor 

func (Api_State) Descriptor() protoreflect.EnumDescriptor

func (Api_State) Enum 

func (x Api_State) Enum() *Api_State

func (Api_State) EnumDescriptor deprecated 

func (Api_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Api_State.Descriptor instead.

func (Api_State) Number 

func (x Api_State) Number() protoreflect.EnumNumber

func (Api_State) String 

func (x Api_State) String() string

func (Api_State) Type 

func (Api_State) Type() protoreflect.EnumType

type Gateway 

type Gateway struct {

	// Output only. Resource name of the Gateway.
	// Format: projects/{project}/locations/{location}/gateways/{gateway}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Created time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Updated time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Optional. Resource labels to represent user-provided metadata.
	// Refer to cloud documentation on labels for more details.
	// https://cloud.google.com/compute/docs/labeling-resources
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Optional. Display name.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. Resource name of the API Config for this Gateway.
	// Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
	ApiConfig string `protobuf:"bytes,6,opt,name=api_config,json=apiConfig,proto3" json:"api_config,omitempty"`
	// Output only. The current state of the Gateway.
	State Gateway_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.events.cloud.apigateway.v1.Gateway_State" json:"state,omitempty"`
	// Output only. The default API Gateway host name of the form
	// `{gateway_id}-{hash}.{region_code}.gateway.dev`.
	DefaultHostname string `protobuf:"bytes,9,opt,name=default_hostname,json=defaultHostname,proto3" json:"default_hostname,omitempty"`
	// contains filtered or unexported fields
}

A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.

func (*Gateway) Descriptor deprecated 

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

Deprecated: Use Gateway.ProtoReflect.Descriptor instead.

func (*Gateway) GetApiConfig 

func (x *Gateway) GetApiConfig() string

func (*Gateway) GetCreateTime 

func (x *Gateway) GetCreateTime() *timestamppb.Timestamp

func (*Gateway) GetDefaultHostname 

func (x *Gateway) GetDefaultHostname() string

func (*Gateway) GetDisplayName 

func (x *Gateway) GetDisplayName() string

func (*Gateway) GetLabels 

func (x *Gateway) GetLabels() map[string]string

func (*Gateway) GetName 

func (x *Gateway) GetName() string

func (*Gateway) GetState 

func (x *Gateway) GetState() Gateway_State

func (*Gateway) GetUpdateTime 

func (x *Gateway) GetUpdateTime() *timestamppb.Timestamp

func (*Gateway) ProtoMessage 

func (*Gateway) ProtoMessage()

func (*Gateway) ProtoReflect 

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

func (*Gateway) Reset 

func (x *Gateway) Reset()

func (*Gateway) String 

func (x *Gateway) String() string

type GatewayEventData 

type GatewayEventData struct {

	// Optional. The Gateway event payload. Unset for deletion events.
	Payload *Gateway `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Gateway events.

func (*GatewayEventData) Descriptor deprecated 

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

Deprecated: Use GatewayEventData.ProtoReflect.Descriptor instead.

func (*GatewayEventData) GetPayload 

func (x *GatewayEventData) GetPayload() *Gateway

func (*GatewayEventData) ProtoMessage 

func (*GatewayEventData) ProtoMessage()

func (*GatewayEventData) ProtoReflect 

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

func (*GatewayEventData) Reset 

func (x *GatewayEventData) Reset()

func (*GatewayEventData) String 

func (x *GatewayEventData) String() string

type Gateway_State 

type Gateway_State int32

All the possible Gateway states. 

const (
	// Gateway does not have a state yet.
	Gateway_STATE_UNSPECIFIED Gateway_State = 0
	// Gateway is being created.
	Gateway_CREATING Gateway_State = 1
	// Gateway is running and ready for requests.
	Gateway_ACTIVE Gateway_State = 2
	// Gateway creation failed.
	Gateway_FAILED Gateway_State = 3
	// Gateway is being deleted.
	Gateway_DELETING Gateway_State = 4
	// Gateway is being updated.
	Gateway_UPDATING Gateway_State = 5
)

func (Gateway_State) Descriptor 

func (Gateway_State) Descriptor() protoreflect.EnumDescriptor

func (Gateway_State) Enum 

func (x Gateway_State) Enum() *Gateway_State

func (Gateway_State) EnumDescriptor deprecated 

func (Gateway_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Gateway_State.Descriptor instead.

func (Gateway_State) Number 

func (x Gateway_State) Number() protoreflect.EnumNumber

func (Gateway_State) String 

func (x Gateway_State) String() string

func (Gateway_State) Type 

func (Gateway_State) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.