Package cloud.google.com/go/apigateway/apiv1/apigatewaypb (v1.7.7)

Version latest

• 1.7.7 (latest)
• 1.7.6
• 1.6.12
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.1
• 0.1.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

ApiGatewayService_ListGateways_FullMethodName, ApiGatewayService_GetGateway_FullMethodName, ApiGatewayService_CreateGateway_FullMethodName, ApiGatewayService_UpdateGateway_FullMethodName, ApiGatewayService_DeleteGateway_FullMethodName, ApiGatewayService_ListApis_FullMethodName, ApiGatewayService_GetApi_FullMethodName, ApiGatewayService_CreateApi_FullMethodName, ApiGatewayService_UpdateApi_FullMethodName, ApiGatewayService_DeleteApi_FullMethodName, ApiGatewayService_ListApiConfigs_FullMethodName, ApiGatewayService_GetApiConfig_FullMethodName, ApiGatewayService_CreateApiConfig_FullMethodName, ApiGatewayService_UpdateApiConfig_FullMethodName, ApiGatewayService_DeleteApiConfig_FullMethodName

const (
	ApiGatewayService_ListGateways_FullMethodName    = "/google.cloud.apigateway.v1.ApiGatewayService/ListGateways"
	ApiGatewayService_GetGateway_FullMethodName      = "/google.cloud.apigateway.v1.ApiGatewayService/GetGateway"
	ApiGatewayService_CreateGateway_FullMethodName   = "/google.cloud.apigateway.v1.ApiGatewayService/CreateGateway"
	ApiGatewayService_UpdateGateway_FullMethodName   = "/google.cloud.apigateway.v1.ApiGatewayService/UpdateGateway"
	ApiGatewayService_DeleteGateway_FullMethodName   = "/google.cloud.apigateway.v1.ApiGatewayService/DeleteGateway"
	ApiGatewayService_ListApis_FullMethodName        = "/google.cloud.apigateway.v1.ApiGatewayService/ListApis"
	ApiGatewayService_GetApi_FullMethodName          = "/google.cloud.apigateway.v1.ApiGatewayService/GetApi"
	ApiGatewayService_CreateApi_FullMethodName       = "/google.cloud.apigateway.v1.ApiGatewayService/CreateApi"
	ApiGatewayService_UpdateApi_FullMethodName       = "/google.cloud.apigateway.v1.ApiGatewayService/UpdateApi"
	ApiGatewayService_DeleteApi_FullMethodName       = "/google.cloud.apigateway.v1.ApiGatewayService/DeleteApi"
	ApiGatewayService_ListApiConfigs_FullMethodName  = "/google.cloud.apigateway.v1.ApiGatewayService/ListApiConfigs"
	ApiGatewayService_GetApiConfig_FullMethodName    = "/google.cloud.apigateway.v1.ApiGatewayService/GetApiConfig"
	ApiGatewayService_CreateApiConfig_FullMethodName = "/google.cloud.apigateway.v1.ApiGatewayService/CreateApiConfig"
	ApiGatewayService_UpdateApiConfig_FullMethodName = "/google.cloud.apigateway.v1.ApiGatewayService/UpdateApiConfig"
	ApiGatewayService_DeleteApiConfig_FullMethodName = "/google.cloud.apigateway.v1.ApiGatewayService/DeleteApiConfig"
)

Variables

Api_State_name, Api_State_value

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.

ApiConfig_State_name, ApiConfig_State_value

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.

Gateway_State_name, Gateway_State_value

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.

GetApiConfigRequest_ConfigView_name, GetApiConfigRequest_ConfigView_value

var (
	GetApiConfigRequest_ConfigView_name = map[int32]string{
		0: "CONFIG_VIEW_UNSPECIFIED",
		1: "BASIC",
		2: "FULL",
	}
	GetApiConfigRequest_ConfigView_value = map[string]int32{
		"CONFIG_VIEW_UNSPECIFIED": 0,
		"BASIC":                   1,
		"FULL":                    2,
	}
)

Enum value maps for GetApiConfigRequest_ConfigView.

ApiGatewayService_ServiceDesc

var ApiGatewayService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.apigateway.v1.ApiGatewayService",
	HandlerType: (*ApiGatewayServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListGateways",
			Handler:    _ApiGatewayService_ListGateways_Handler,
		},
		{
			MethodName: "GetGateway",
			Handler:    _ApiGatewayService_GetGateway_Handler,
		},
		{
			MethodName: "CreateGateway",
			Handler:    _ApiGatewayService_CreateGateway_Handler,
		},
		{
			MethodName: "UpdateGateway",
			Handler:    _ApiGatewayService_UpdateGateway_Handler,
		},
		{
			MethodName: "DeleteGateway",
			Handler:    _ApiGatewayService_DeleteGateway_Handler,
		},
		{
			MethodName: "ListApis",
			Handler:    _ApiGatewayService_ListApis_Handler,
		},
		{
			MethodName: "GetApi",
			Handler:    _ApiGatewayService_GetApi_Handler,
		},
		{
			MethodName: "CreateApi",
			Handler:    _ApiGatewayService_CreateApi_Handler,
		},
		{
			MethodName: "UpdateApi",
			Handler:    _ApiGatewayService_UpdateApi_Handler,
		},
		{
			MethodName: "DeleteApi",
			Handler:    _ApiGatewayService_DeleteApi_Handler,
		},
		{
			MethodName: "ListApiConfigs",
			Handler:    _ApiGatewayService_ListApiConfigs_Handler,
		},
		{
			MethodName: "GetApiConfig",
			Handler:    _ApiGatewayService_GetApiConfig_Handler,
		},
		{
			MethodName: "CreateApiConfig",
			Handler:    _ApiGatewayService_CreateApiConfig_Handler,
		},
		{
			MethodName: "UpdateApiConfig",
			Handler:    _ApiGatewayService_UpdateApiConfig_Handler,
		},
		{
			MethodName: "DeleteApiConfig",
			Handler:    _ApiGatewayService_DeleteApiConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/apigateway/v1/apigateway_service.proto",
}

ApiGatewayService_ServiceDesc is the grpc.ServiceDesc for ApiGatewayService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

File_google_cloud_apigateway_v1_apigateway_proto

var File_google_cloud_apigateway_v1_apigateway_proto protoreflect.FileDescriptor

File_google_cloud_apigateway_v1_apigateway_service_proto

var File_google_cloud_apigateway_v1_apigateway_service_proto protoreflect.FileDescriptor

Functions

func RegisterApiGatewayServiceServer

func RegisterApiGatewayServiceServer(s grpc.ServiceRegistrar, srv ApiGatewayServiceServer)

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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// 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.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

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

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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// 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 `protobuf:"bytes,14,opt,name=gateway_service_account,json=gatewayServiceAccount,proto3" json:"gateway_service_account,omitempty"`
	// 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.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 `protobuf:"bytes,11,rep,name=managed_service_configs,json=managedServiceConfigs,proto3" json:"managed_service_configs,omitempty"`
	// 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

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

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

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

ApiConfig_GrpcServiceDefinition

type ApiConfig_GrpcServiceDefinition struct {

	// Input only. File descriptor set, generated by protoc.
	//
	// To generate, use protoc with imports and source info included.
	// For an example test.proto file, the following command would put the value
	// in a new file named out.pb.
	//
	// $ protoc --include_imports --include_source_info test.proto -o out.pb
	FileDescriptorSet *ApiConfig_File `protobuf:"bytes,1,opt,name=file_descriptor_set,json=fileDescriptorSet,proto3" json:"file_descriptor_set,omitempty"`
	// 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

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

Deprecated: Use ApiConfig_GrpcServiceDefinition.ProtoReflect.Descriptor instead.

func (*ApiConfig_GrpcServiceDefinition) GetFileDescriptorSet

func (x *ApiConfig_GrpcServiceDefinition) GetFileDescriptorSet() *ApiConfig_File

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

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

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

ApiConfig_State

type ApiConfig_State int32

All the possible API Config states.

ApiConfig_STATE_UNSPECIFIED, ApiConfig_CREATING, ApiConfig_ACTIVE, ApiConfig_FAILED, ApiConfig_DELETING, ApiConfig_UPDATING, ApiConfig_ACTIVATING

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

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

ApiGatewayServiceClient

type ApiGatewayServiceClient interface {
	// Lists Gateways in a given project and location.
	ListGateways(ctx context.Context, in *ListGatewaysRequest, opts ...grpc.CallOption) (*ListGatewaysResponse, error)
	// Gets details of a single Gateway.
	GetGateway(ctx context.Context, in *GetGatewayRequest, opts ...grpc.CallOption) (*Gateway, error)
	// Creates a new Gateway in a given project and location.
	CreateGateway(ctx context.Context, in *CreateGatewayRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Gateway.
	UpdateGateway(ctx context.Context, in *UpdateGatewayRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Gateway.
	DeleteGateway(ctx context.Context, in *DeleteGatewayRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists Apis in a given project and location.
	ListApis(ctx context.Context, in *ListApisRequest, opts ...grpc.CallOption) (*ListApisResponse, error)
	// Gets details of a single Api.
	GetApi(ctx context.Context, in *GetApiRequest, opts ...grpc.CallOption) (*Api, error)
	// Creates a new Api in a given project and location.
	CreateApi(ctx context.Context, in *CreateApiRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Api.
	UpdateApi(ctx context.Context, in *UpdateApiRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Api.
	DeleteApi(ctx context.Context, in *DeleteApiRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists ApiConfigs in a given project and location.
	ListApiConfigs(ctx context.Context, in *ListApiConfigsRequest, opts ...grpc.CallOption) (*ListApiConfigsResponse, error)
	// Gets details of a single ApiConfig.
	GetApiConfig(ctx context.Context, in *GetApiConfigRequest, opts ...grpc.CallOption) (*ApiConfig, error)
	// Creates a new ApiConfig in a given project and location.
	CreateApiConfig(ctx context.Context, in *CreateApiConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single ApiConfig.
	UpdateApiConfig(ctx context.Context, in *UpdateApiConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single ApiConfig.
	DeleteApiConfig(ctx context.Context, in *DeleteApiConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

ApiGatewayServiceClient is the client API for ApiGatewayService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewApiGatewayServiceClient

func NewApiGatewayServiceClient(cc grpc.ClientConnInterface) ApiGatewayServiceClient

ApiGatewayServiceServer

type ApiGatewayServiceServer interface {
	// Lists Gateways in a given project and location.
	ListGateways(context.Context, *ListGatewaysRequest) (*ListGatewaysResponse, error)
	// Gets details of a single Gateway.
	GetGateway(context.Context, *GetGatewayRequest) (*Gateway, error)
	// Creates a new Gateway in a given project and location.
	CreateGateway(context.Context, *CreateGatewayRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Gateway.
	UpdateGateway(context.Context, *UpdateGatewayRequest) (*longrunningpb.Operation, error)
	// Deletes a single Gateway.
	DeleteGateway(context.Context, *DeleteGatewayRequest) (*longrunningpb.Operation, error)
	// Lists Apis in a given project and location.
	ListApis(context.Context, *ListApisRequest) (*ListApisResponse, error)
	// Gets details of a single Api.
	GetApi(context.Context, *GetApiRequest) (*Api, error)
	// Creates a new Api in a given project and location.
	CreateApi(context.Context, *CreateApiRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Api.
	UpdateApi(context.Context, *UpdateApiRequest) (*longrunningpb.Operation, error)
	// Deletes a single Api.
	DeleteApi(context.Context, *DeleteApiRequest) (*longrunningpb.Operation, error)
	// Lists ApiConfigs in a given project and location.
	ListApiConfigs(context.Context, *ListApiConfigsRequest) (*ListApiConfigsResponse, error)
	// Gets details of a single ApiConfig.
	GetApiConfig(context.Context, *GetApiConfigRequest) (*ApiConfig, error)
	// Creates a new ApiConfig in a given project and location.
	CreateApiConfig(context.Context, *CreateApiConfigRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single ApiConfig.
	UpdateApiConfig(context.Context, *UpdateApiConfigRequest) (*longrunningpb.Operation, error)
	// Deletes a single ApiConfig.
	DeleteApiConfig(context.Context, *DeleteApiConfigRequest) (*longrunningpb.Operation, error)
}

ApiGatewayServiceServer is the server API for ApiGatewayService service. All implementations should embed UnimplementedApiGatewayServiceServer for forward compatibility

Api_State

type Api_State int32

All the possible API states.

Api_STATE_UNSPECIFIED, Api_CREATING, Api_ACTIVE, Api_FAILED, Api_DELETING, Api_UPDATING

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

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

CreateApiConfigRequest

type CreateApiConfigRequest struct {

	// Required. Parent resource of the API Config, of the form:
	// `projects/*/locations/global/apis/*`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Identifier to assign to the API Config. Must be unique within scope of
	// the parent resource.
	ApiConfigId string `protobuf:"bytes,2,opt,name=api_config_id,json=apiConfigId,proto3" json:"api_config_id,omitempty"`
	// Required. API resource.
	ApiConfig *ApiConfig `protobuf:"bytes,3,opt,name=api_config,json=apiConfig,proto3" json:"api_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.CreateApiConfig

func (*CreateApiConfigRequest) Descriptor

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

Deprecated: Use CreateApiConfigRequest.ProtoReflect.Descriptor instead.

func (*CreateApiConfigRequest) GetApiConfig

func (x *CreateApiConfigRequest) GetApiConfig() *ApiConfig

func (*CreateApiConfigRequest) GetApiConfigId

func (x *CreateApiConfigRequest) GetApiConfigId() string

func (*CreateApiConfigRequest) GetParent

func (x *CreateApiConfigRequest) GetParent() string

func (*CreateApiConfigRequest) ProtoMessage

func (*CreateApiConfigRequest) ProtoMessage()

func (*CreateApiConfigRequest) ProtoReflect

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

func (*CreateApiConfigRequest) Reset

func (x *CreateApiConfigRequest) Reset()

func (*CreateApiConfigRequest) String

func (x *CreateApiConfigRequest) String() string

CreateApiRequest

type CreateApiRequest struct {

	// Required. Parent resource of the API, of the form:
	// `projects/*/locations/global`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Identifier to assign to the API. Must be unique within scope of
	// the parent resource.
	ApiId string `protobuf:"bytes,2,opt,name=api_id,json=apiId,proto3" json:"api_id,omitempty"`
	// Required. API resource.
	Api *Api `protobuf:"bytes,3,opt,name=api,proto3" json:"api,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.CreateApi

func (*CreateApiRequest) Descriptor

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

Deprecated: Use CreateApiRequest.ProtoReflect.Descriptor instead.

func (*CreateApiRequest) GetApi

func (x *CreateApiRequest) GetApi() *Api

func (*CreateApiRequest) GetApiId

func (x *CreateApiRequest) GetApiId() string

func (*CreateApiRequest) GetParent

func (x *CreateApiRequest) GetParent() string

func (*CreateApiRequest) ProtoMessage

func (*CreateApiRequest) ProtoMessage()

func (*CreateApiRequest) ProtoReflect

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

func (*CreateApiRequest) Reset

func (x *CreateApiRequest) Reset()

func (*CreateApiRequest) String

func (x *CreateApiRequest) String() string

CreateGatewayRequest

type CreateGatewayRequest struct {

	// Required. Parent resource of the Gateway, of the form:
	// `projects/*/locations/*`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Identifier to assign to the Gateway. Must be unique within scope of
	// the parent resource.
	GatewayId string `protobuf:"bytes,2,opt,name=gateway_id,json=gatewayId,proto3" json:"gateway_id,omitempty"`
	// Required. Gateway resource.
	Gateway *Gateway `protobuf:"bytes,3,opt,name=gateway,proto3" json:"gateway,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.CreateGateway

func (*CreateGatewayRequest) Descriptor

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

Deprecated: Use CreateGatewayRequest.ProtoReflect.Descriptor instead.

func (*CreateGatewayRequest) GetGateway

func (x *CreateGatewayRequest) GetGateway() *Gateway

func (*CreateGatewayRequest) GetGatewayId

func (x *CreateGatewayRequest) GetGatewayId() string

func (*CreateGatewayRequest) GetParent

func (x *CreateGatewayRequest) GetParent() string

func (*CreateGatewayRequest) ProtoMessage

func (*CreateGatewayRequest) ProtoMessage()

func (*CreateGatewayRequest) ProtoReflect

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

func (*CreateGatewayRequest) Reset

func (x *CreateGatewayRequest) Reset()

func (*CreateGatewayRequest) String

func (x *CreateGatewayRequest) String() string

DeleteApiConfigRequest

type DeleteApiConfigRequest struct {

	// Required. Resource name of the form:
	// `projects/*/locations/global/apis/*/configs/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.DeleteApiConfig

func (*DeleteApiConfigRequest) Descriptor

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

Deprecated: Use DeleteApiConfigRequest.ProtoReflect.Descriptor instead.

func (*DeleteApiConfigRequest) GetName

func (x *DeleteApiConfigRequest) GetName() string

func (*DeleteApiConfigRequest) ProtoMessage

func (*DeleteApiConfigRequest) ProtoMessage()

func (*DeleteApiConfigRequest) ProtoReflect

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

func (*DeleteApiConfigRequest) Reset

func (x *DeleteApiConfigRequest) Reset()

func (*DeleteApiConfigRequest) String

func (x *DeleteApiConfigRequest) String() string

DeleteApiRequest

type DeleteApiRequest struct {

	// Required. Resource name of the form:
	// `projects/*/locations/global/apis/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.DeleteApi

func (*DeleteApiRequest) Descriptor

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

Deprecated: Use DeleteApiRequest.ProtoReflect.Descriptor instead.

func (*DeleteApiRequest) GetName

func (x *DeleteApiRequest) GetName() string

func (*DeleteApiRequest) ProtoMessage

func (*DeleteApiRequest) ProtoMessage()

func (*DeleteApiRequest) ProtoReflect

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

func (*DeleteApiRequest) Reset

func (x *DeleteApiRequest) Reset()

func (*DeleteApiRequest) String

func (x *DeleteApiRequest) String() string

DeleteGatewayRequest

type DeleteGatewayRequest struct {

	// Required. Resource name of the form:
	// `projects/*/locations/*/gateways/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.DeleteGateway

func (*DeleteGatewayRequest) Descriptor

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

Deprecated: Use DeleteGatewayRequest.ProtoReflect.Descriptor instead.

func (*DeleteGatewayRequest) GetName

func (x *DeleteGatewayRequest) GetName() string

func (*DeleteGatewayRequest) ProtoMessage

func (*DeleteGatewayRequest) ProtoMessage()

func (*DeleteGatewayRequest) ProtoReflect

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

func (*DeleteGatewayRequest) Reset

func (x *DeleteGatewayRequest) Reset()

func (*DeleteGatewayRequest) String

func (x *DeleteGatewayRequest) String() string

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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// 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.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

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

Gateway_State

type Gateway_State int32

All the possible Gateway states.

Gateway_STATE_UNSPECIFIED, Gateway_CREATING, Gateway_ACTIVE, Gateway_FAILED, Gateway_DELETING, Gateway_UPDATING

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

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

GetApiConfigRequest

type GetApiConfigRequest struct {

	// Required. Resource name of the form:
	// `projects/*/locations/global/apis/*/configs/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies which fields of the API Config are returned in the response.
	// Defaults to `BASIC` view.
	View GetApiConfigRequest_ConfigView `protobuf:"varint,3,opt,name=view,proto3,enum=google.cloud.apigateway.v1.GetApiConfigRequest_ConfigView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.GetApiConfig

func (*GetApiConfigRequest) Descriptor

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

Deprecated: Use GetApiConfigRequest.ProtoReflect.Descriptor instead.

func (*GetApiConfigRequest) GetName

func (x *GetApiConfigRequest) GetName() string

func (*GetApiConfigRequest) GetView

func (x *GetApiConfigRequest) GetView() GetApiConfigRequest_ConfigView

func (*GetApiConfigRequest) ProtoMessage

func (*GetApiConfigRequest) ProtoMessage()

func (*GetApiConfigRequest) ProtoReflect

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

func (*GetApiConfigRequest) Reset

func (x *GetApiConfigRequest) Reset()

func (*GetApiConfigRequest) String

func (x *GetApiConfigRequest) String() string

GetApiConfigRequest_ConfigView

type GetApiConfigRequest_ConfigView int32

Enum to control which fields should be included in the response.

GetApiConfigRequest_CONFIG_VIEW_UNSPECIFIED, GetApiConfigRequest_BASIC, GetApiConfigRequest_FULL

const (
	GetApiConfigRequest_CONFIG_VIEW_UNSPECIFIED GetApiConfigRequest_ConfigView = 0
	// Do not include configuration source files.
	GetApiConfigRequest_BASIC GetApiConfigRequest_ConfigView = 1
	// Include configuration source files.
	GetApiConfigRequest_FULL GetApiConfigRequest_ConfigView = 2
)

func (GetApiConfigRequest_ConfigView) Descriptor

func (GetApiConfigRequest_ConfigView) Descriptor() protoreflect.EnumDescriptor

func (GetApiConfigRequest_ConfigView) Enum

func (x GetApiConfigRequest_ConfigView) Enum() *GetApiConfigRequest_ConfigView

func (GetApiConfigRequest_ConfigView) EnumDescriptor

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

Deprecated: Use GetApiConfigRequest_ConfigView.Descriptor instead.

func (GetApiConfigRequest_ConfigView) Number

func (x GetApiConfigRequest_ConfigView) Number() protoreflect.EnumNumber

func (GetApiConfigRequest_ConfigView) String

func (x GetApiConfigRequest_ConfigView) String() string

func (GetApiConfigRequest_ConfigView) Type

func (GetApiConfigRequest_ConfigView) Type() protoreflect.EnumType

GetApiRequest

type GetApiRequest struct {

	// Required. Resource name of the form:
	// `projects/*/locations/global/apis/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.GetApi

func (*GetApiRequest) Descriptor

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

Deprecated: Use GetApiRequest.ProtoReflect.Descriptor instead.

func (*GetApiRequest) GetName

func (x *GetApiRequest) GetName() string

func (*GetApiRequest) ProtoMessage

func (*GetApiRequest) ProtoMessage()

func (*GetApiRequest) ProtoReflect

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

func (*GetApiRequest) Reset

func (x *GetApiRequest) Reset()

func (*GetApiRequest) String

func (x *GetApiRequest) String() string

GetGatewayRequest

type GetGatewayRequest struct {

	// Required. Resource name of the form:
	// `projects/*/locations/*/gateways/*`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.GetGateway

func (*GetGatewayRequest) Descriptor

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

Deprecated: Use GetGatewayRequest.ProtoReflect.Descriptor instead.

func (*GetGatewayRequest) GetName

func (x *GetGatewayRequest) GetName() string

func (*GetGatewayRequest) ProtoMessage

func (*GetGatewayRequest) ProtoMessage()

func (*GetGatewayRequest) ProtoReflect

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

func (*GetGatewayRequest) Reset

func (x *GetGatewayRequest) Reset()

func (*GetGatewayRequest) String

func (x *GetGatewayRequest) String() string

ListApiConfigsRequest

type ListApiConfigsRequest struct {

	// Required. Parent resource of the API Config, of the form:
	// `projects/*/locations/global/apis/*`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Order by parameters.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.ListApiConfigs

func (*ListApiConfigsRequest) Descriptor

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

Deprecated: Use ListApiConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListApiConfigsRequest) GetFilter

func (x *ListApiConfigsRequest) GetFilter() string

func (*ListApiConfigsRequest) GetOrderBy

func (x *ListApiConfigsRequest) GetOrderBy() string

func (*ListApiConfigsRequest) GetPageSize

func (x *ListApiConfigsRequest) GetPageSize() int32

func (*ListApiConfigsRequest) GetPageToken

func (x *ListApiConfigsRequest) GetPageToken() string

func (*ListApiConfigsRequest) GetParent

func (x *ListApiConfigsRequest) GetParent() string

func (*ListApiConfigsRequest) ProtoMessage

func (*ListApiConfigsRequest) ProtoMessage()

func (*ListApiConfigsRequest) ProtoReflect

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

func (*ListApiConfigsRequest) Reset

func (x *ListApiConfigsRequest) Reset()

func (*ListApiConfigsRequest) String

func (x *ListApiConfigsRequest) String() string

ListApiConfigsResponse

type ListApiConfigsResponse struct {

	// API Configs.
	ApiConfigs []*ApiConfig `protobuf:"bytes,1,rep,name=api_configs,json=apiConfigs,proto3" json:"api_configs,omitempty"`
	// Next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	UnreachableLocations []string `protobuf:"bytes,3,rep,name=unreachable_locations,json=unreachableLocations,proto3" json:"unreachable_locations,omitempty"`
	// contains filtered or unexported fields
}

Response message for ApiGatewayService.ListApiConfigs

func (*ListApiConfigsResponse) Descriptor

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

Deprecated: Use ListApiConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListApiConfigsResponse) GetApiConfigs

func (x *ListApiConfigsResponse) GetApiConfigs() []*ApiConfig

func (*ListApiConfigsResponse) GetNextPageToken

func (x *ListApiConfigsResponse) GetNextPageToken() string

func (*ListApiConfigsResponse) GetUnreachableLocations

func (x *ListApiConfigsResponse) GetUnreachableLocations() []string

func (*ListApiConfigsResponse) ProtoMessage

func (*ListApiConfigsResponse) ProtoMessage()

func (*ListApiConfigsResponse) ProtoReflect

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

func (*ListApiConfigsResponse) Reset

func (x *ListApiConfigsResponse) Reset()

func (*ListApiConfigsResponse) String

func (x *ListApiConfigsResponse) String() string

ListApisRequest

type ListApisRequest struct {

	// Required. Parent resource of the API, of the form:
	// `projects/*/locations/global`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Order by parameters.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.ListApis

func (*ListApisRequest) Descriptor

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

Deprecated: Use ListApisRequest.ProtoReflect.Descriptor instead.

func (*ListApisRequest) GetFilter

func (x *ListApisRequest) GetFilter() string

func (*ListApisRequest) GetOrderBy

func (x *ListApisRequest) GetOrderBy() string

func (*ListApisRequest) GetPageSize

func (x *ListApisRequest) GetPageSize() int32

func (*ListApisRequest) GetPageToken

func (x *ListApisRequest) GetPageToken() string

func (*ListApisRequest) GetParent

func (x *ListApisRequest) GetParent() string

func (*ListApisRequest) ProtoMessage

func (*ListApisRequest) ProtoMessage()

func (*ListApisRequest) ProtoReflect

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

func (*ListApisRequest) Reset

func (x *ListApisRequest) Reset()

func (*ListApisRequest) String

func (x *ListApisRequest) String() string

ListApisResponse

type ListApisResponse struct {

	// APIs.
	Apis []*Api `protobuf:"bytes,1,rep,name=apis,proto3" json:"apis,omitempty"`
	// Next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	UnreachableLocations []string `protobuf:"bytes,3,rep,name=unreachable_locations,json=unreachableLocations,proto3" json:"unreachable_locations,omitempty"`
	// contains filtered or unexported fields
}

Response message for ApiGatewayService.ListApis

func (*ListApisResponse) Descriptor

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

Deprecated: Use ListApisResponse.ProtoReflect.Descriptor instead.

func (*ListApisResponse) GetApis

func (x *ListApisResponse) GetApis() []*Api

func (*ListApisResponse) GetNextPageToken

func (x *ListApisResponse) GetNextPageToken() string

func (*ListApisResponse) GetUnreachableLocations

func (x *ListApisResponse) GetUnreachableLocations() []string

func (*ListApisResponse) ProtoMessage

func (*ListApisResponse) ProtoMessage()

func (*ListApisResponse) ProtoReflect

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

func (*ListApisResponse) Reset

func (x *ListApisResponse) Reset()

func (*ListApisResponse) String

func (x *ListApisResponse) String() string

ListGatewaysRequest

type ListGatewaysRequest struct {

	// Required. Parent resource of the Gateway, of the form:
	// `projects/*/locations/*`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Page size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Order by parameters.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.ListGateways

func (*ListGatewaysRequest) Descriptor

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

Deprecated: Use ListGatewaysRequest.ProtoReflect.Descriptor instead.

func (*ListGatewaysRequest) GetFilter

func (x *ListGatewaysRequest) GetFilter() string

func (*ListGatewaysRequest) GetOrderBy

func (x *ListGatewaysRequest) GetOrderBy() string

func (*ListGatewaysRequest) GetPageSize

func (x *ListGatewaysRequest) GetPageSize() int32

func (*ListGatewaysRequest) GetPageToken

func (x *ListGatewaysRequest) GetPageToken() string

func (*ListGatewaysRequest) GetParent

func (x *ListGatewaysRequest) GetParent() string

func (*ListGatewaysRequest) ProtoMessage

func (*ListGatewaysRequest) ProtoMessage()

func (*ListGatewaysRequest) ProtoReflect

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

func (*ListGatewaysRequest) Reset

func (x *ListGatewaysRequest) Reset()

func (*ListGatewaysRequest) String

func (x *ListGatewaysRequest) String() string

ListGatewaysResponse

type ListGatewaysResponse struct {

	// Gateways.
	Gateways []*Gateway `protobuf:"bytes,1,rep,name=gateways,proto3" json:"gateways,omitempty"`
	// Next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	UnreachableLocations []string `protobuf:"bytes,3,rep,name=unreachable_locations,json=unreachableLocations,proto3" json:"unreachable_locations,omitempty"`
	// contains filtered or unexported fields
}

Response message for ApiGatewayService.ListGateways

func (*ListGatewaysResponse) Descriptor

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

Deprecated: Use ListGatewaysResponse.ProtoReflect.Descriptor instead.

func (*ListGatewaysResponse) GetGateways

func (x *ListGatewaysResponse) GetGateways() []*Gateway

func (*ListGatewaysResponse) GetNextPageToken

func (x *ListGatewaysResponse) GetNextPageToken() string

func (*ListGatewaysResponse) GetUnreachableLocations

func (x *ListGatewaysResponse) GetUnreachableLocations() []string

func (*ListGatewaysResponse) ProtoMessage

func (*ListGatewaysResponse) ProtoMessage()

func (*ListGatewaysResponse) ProtoReflect

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

func (*ListGatewaysResponse) Reset

func (x *ListGatewaysResponse) Reset()

func (*ListGatewaysResponse) String

func (x *ListGatewaysResponse) String() string

OperationMetadata

type OperationMetadata struct {

	// Output only. The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the operation finished running.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Server-defined resource path for the target of the operation.
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Output only. Name of the verb executed by the operation.
	Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
	// Output only. Human-readable status of the operation, if any.
	StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
	// Output only. Identifies whether the user has requested cancellation
	// of the operation. Operations that have successfully been cancelled
	// have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
	// Output only. API version used to start the operation.
	ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// Output only. Diagnostics generated during processing of configuration source files.
	Diagnostics []*OperationMetadata_Diagnostic `protobuf:"bytes,8,rep,name=diagnostics,proto3" json:"diagnostics,omitempty"`
	// contains filtered or unexported fields
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime

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

func (*OperationMetadata) GetDiagnostics

func (x *OperationMetadata) GetDiagnostics() []*OperationMetadata_Diagnostic

func (*OperationMetadata) GetEndTime

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetRequestedCancellation

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

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

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

OperationMetadata_Diagnostic

type OperationMetadata_Diagnostic struct {

	// Location of the diagnostic.
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// The diagnostic message.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Diagnostic information from configuration processing.

func (*OperationMetadata_Diagnostic) Descriptor

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

Deprecated: Use OperationMetadata_Diagnostic.ProtoReflect.Descriptor instead.

func (*OperationMetadata_Diagnostic) GetLocation

func (x *OperationMetadata_Diagnostic) GetLocation() string

func (*OperationMetadata_Diagnostic) GetMessage

func (x *OperationMetadata_Diagnostic) GetMessage() string

func (*OperationMetadata_Diagnostic) ProtoMessage

func (*OperationMetadata_Diagnostic) ProtoMessage()

func (*OperationMetadata_Diagnostic) ProtoReflect

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

func (*OperationMetadata_Diagnostic) Reset

func (x *OperationMetadata_Diagnostic) Reset()

func (*OperationMetadata_Diagnostic) String

func (x *OperationMetadata_Diagnostic) String() string

UnimplementedApiGatewayServiceServer

type UnimplementedApiGatewayServiceServer struct {
}

UnimplementedApiGatewayServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedApiGatewayServiceServer) CreateApi

func (UnimplementedApiGatewayServiceServer) CreateApi(context.Context, *CreateApiRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) CreateApiConfig

func (UnimplementedApiGatewayServiceServer) CreateApiConfig(context.Context, *CreateApiConfigRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) CreateGateway

func (UnimplementedApiGatewayServiceServer) CreateGateway(context.Context, *CreateGatewayRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) DeleteApi

func (UnimplementedApiGatewayServiceServer) DeleteApi(context.Context, *DeleteApiRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) DeleteApiConfig

func (UnimplementedApiGatewayServiceServer) DeleteApiConfig(context.Context, *DeleteApiConfigRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) DeleteGateway

func (UnimplementedApiGatewayServiceServer) DeleteGateway(context.Context, *DeleteGatewayRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) GetApi

func (UnimplementedApiGatewayServiceServer) GetApi(context.Context, *GetApiRequest) (*Api, error)

func (UnimplementedApiGatewayServiceServer) GetApiConfig

func (UnimplementedApiGatewayServiceServer) GetApiConfig(context.Context, *GetApiConfigRequest) (*ApiConfig, error)

func (UnimplementedApiGatewayServiceServer) GetGateway

func (UnimplementedApiGatewayServiceServer) GetGateway(context.Context, *GetGatewayRequest) (*Gateway, error)

func (UnimplementedApiGatewayServiceServer) ListApiConfigs

func (UnimplementedApiGatewayServiceServer) ListApiConfigs(context.Context, *ListApiConfigsRequest) (*ListApiConfigsResponse, error)

func (UnimplementedApiGatewayServiceServer) ListApis

func (UnimplementedApiGatewayServiceServer) ListApis(context.Context, *ListApisRequest) (*ListApisResponse, error)

func (UnimplementedApiGatewayServiceServer) ListGateways

func (UnimplementedApiGatewayServiceServer) ListGateways(context.Context, *ListGatewaysRequest) (*ListGatewaysResponse, error)

func (UnimplementedApiGatewayServiceServer) UpdateApi

func (UnimplementedApiGatewayServiceServer) UpdateApi(context.Context, *UpdateApiRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) UpdateApiConfig

func (UnimplementedApiGatewayServiceServer) UpdateApiConfig(context.Context, *UpdateApiConfigRequest) (*longrunningpb.Operation, error)

func (UnimplementedApiGatewayServiceServer) UpdateGateway

func (UnimplementedApiGatewayServiceServer) UpdateGateway(context.Context, *UpdateGatewayRequest) (*longrunningpb.Operation, error)

UnsafeApiGatewayServiceServer

type UnsafeApiGatewayServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeApiGatewayServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ApiGatewayServiceServer will result in compilation errors.

UpdateApiConfigRequest

type UpdateApiConfigRequest struct {

	// Field mask is used to specify the fields to be overwritten in the
	// ApiConfig resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. API Config resource.
	ApiConfig *ApiConfig `protobuf:"bytes,2,opt,name=api_config,json=apiConfig,proto3" json:"api_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.UpdateApiConfig

func (*UpdateApiConfigRequest) Descriptor

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

Deprecated: Use UpdateApiConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateApiConfigRequest) GetApiConfig

func (x *UpdateApiConfigRequest) GetApiConfig() *ApiConfig

func (*UpdateApiConfigRequest) GetUpdateMask

func (x *UpdateApiConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateApiConfigRequest) ProtoMessage

func (*UpdateApiConfigRequest) ProtoMessage()

func (*UpdateApiConfigRequest) ProtoReflect

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

func (*UpdateApiConfigRequest) Reset

func (x *UpdateApiConfigRequest) Reset()

func (*UpdateApiConfigRequest) String

func (x *UpdateApiConfigRequest) String() string

UpdateApiRequest

type UpdateApiRequest struct {

	// Field mask is used to specify the fields to be overwritten in the
	// Api resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. API resource.
	Api *Api `protobuf:"bytes,2,opt,name=api,proto3" json:"api,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.UpdateApi

func (*UpdateApiRequest) Descriptor

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

Deprecated: Use UpdateApiRequest.ProtoReflect.Descriptor instead.

func (*UpdateApiRequest) GetApi

func (x *UpdateApiRequest) GetApi() *Api

func (*UpdateApiRequest) GetUpdateMask

func (x *UpdateApiRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateApiRequest) ProtoMessage

func (*UpdateApiRequest) ProtoMessage()

func (*UpdateApiRequest) ProtoReflect

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

func (*UpdateApiRequest) Reset

func (x *UpdateApiRequest) Reset()

func (*UpdateApiRequest) String

func (x *UpdateApiRequest) String() string

UpdateGatewayRequest

type UpdateGatewayRequest struct {

	// Field mask is used to specify the fields to be overwritten in the
	// Gateway resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. Gateway resource.
	Gateway *Gateway `protobuf:"bytes,2,opt,name=gateway,proto3" json:"gateway,omitempty"`
	// contains filtered or unexported fields
}

Request message for ApiGatewayService.UpdateGateway

func (*UpdateGatewayRequest) Descriptor

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

Deprecated: Use UpdateGatewayRequest.ProtoReflect.Descriptor instead.

func (*UpdateGatewayRequest) GetGateway

func (x *UpdateGatewayRequest) GetGateway() *Gateway

func (*UpdateGatewayRequest) GetUpdateMask

func (x *UpdateGatewayRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateGatewayRequest) ProtoMessage

func (*UpdateGatewayRequest) ProtoMessage()

func (*UpdateGatewayRequest) ProtoReflect

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

func (*UpdateGatewayRequest) Reset

func (x *UpdateGatewayRequest) Reset()

func (*UpdateGatewayRequest) String

func (x *UpdateGatewayRequest) String() string