ai_gateway

package
v2.2.0 Latest Latest
Warning

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

 Go to latest Published: May 9, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type AIGatewayDeleteParams 

type AIGatewayDeleteParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type AIGatewayDeleteResponse 

type AIGatewayDeleteResponse struct {
	ID                      string                      `json:"id,required" format:"uuid"`
	CacheInvalidateOnUpdate bool                        `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                       `json:"cache_ttl,required"`
	CollectLogs             bool                        `json:"collect_logs,required"`
	CreatedAt               time.Time                   `json:"created_at,required" format:"date-time"`
	ModifiedAt              time.Time                   `json:"modified_at,required" format:"date-time"`
	Name                    string                      `json:"name,required"`
	Slug                    string                      `json:"slug,required"`
	RateLimitingInterval    int64                       `json:"rate_limiting_interval"`
	RateLimitingLimit       int64                       `json:"rate_limiting_limit"`
	RateLimitingTechnique   string                      `json:"rate_limiting_technique"`
	JSON                    aiGatewayDeleteResponseJSON `json:"-"`
}

func (*AIGatewayDeleteResponse) UnmarshalJSON 

func (r *AIGatewayDeleteResponse) UnmarshalJSON(data []byte) (err error)

type AIGatewayDeleteResponseEnvelope 

type AIGatewayDeleteResponseEnvelope struct {
	Result  AIGatewayDeleteResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    aiGatewayDeleteResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayDeleteResponseEnvelope) UnmarshalJSON 

func (r *AIGatewayDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AIGatewayGetParams 

type AIGatewayGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type AIGatewayGetResponse 

type AIGatewayGetResponse struct {
	ID                      string                   `json:"id,required" format:"uuid"`
	CacheInvalidateOnUpdate bool                     `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                    `json:"cache_ttl,required"`
	CollectLogs             bool                     `json:"collect_logs,required"`
	CreatedAt               time.Time                `json:"created_at,required" format:"date-time"`
	ModifiedAt              time.Time                `json:"modified_at,required" format:"date-time"`
	Name                    string                   `json:"name,required"`
	Slug                    string                   `json:"slug,required"`
	RateLimitingInterval    int64                    `json:"rate_limiting_interval"`
	RateLimitingLimit       int64                    `json:"rate_limiting_limit"`
	RateLimitingTechnique   string                   `json:"rate_limiting_technique"`
	JSON                    aiGatewayGetResponseJSON `json:"-"`
}

func (*AIGatewayGetResponse) UnmarshalJSON 

func (r *AIGatewayGetResponse) UnmarshalJSON(data []byte) (err error)

type AIGatewayGetResponseEnvelope 

type AIGatewayGetResponseEnvelope struct {
	Result  AIGatewayGetResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    aiGatewayGetResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayGetResponseEnvelope) UnmarshalJSON 

func (r *AIGatewayGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AIGatewayListParams 

type AIGatewayListParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
	ID        param.Field[string] `query:"id" format:"uuid"`
	// Order By Column Name
	OrderBy param.Field[string] `query:"order_by"`
	Page    param.Field[int64]  `query:"page"`
	PerPage param.Field[int64]  `query:"per_page"`
}

func (AIGatewayListParams) URLQuery 

func (r AIGatewayListParams) URLQuery() (v url.Values)

URLQuery serializes AIGatewayListParams's query parameters as `url.Values`.

type AIGatewayListResponse 

type AIGatewayListResponse struct {
	ID                      string                    `json:"id,required" format:"uuid"`
	CacheInvalidateOnUpdate bool                      `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                     `json:"cache_ttl,required"`
	CollectLogs             bool                      `json:"collect_logs,required"`
	CreatedAt               time.Time                 `json:"created_at,required" format:"date-time"`
	ModifiedAt              time.Time                 `json:"modified_at,required" format:"date-time"`
	Name                    string                    `json:"name,required"`
	Slug                    string                    `json:"slug,required"`
	RateLimitingInterval    int64                     `json:"rate_limiting_interval"`
	RateLimitingLimit       int64                     `json:"rate_limiting_limit"`
	RateLimitingTechnique   string                    `json:"rate_limiting_technique"`
	JSON                    aiGatewayListResponseJSON `json:"-"`
}

func (*AIGatewayListResponse) UnmarshalJSON 

func (r *AIGatewayListResponse) UnmarshalJSON(data []byte) (err error)

type AIGatewayNewParams 

type AIGatewayNewParams struct {
	AccountID               param.Field[string] `path:"account_id,required"`
	CacheInvalidateOnUpdate param.Field[bool]   `json:"cache_invalidate_on_update,required"`
	CacheTTL                param.Field[int64]  `json:"cache_ttl,required"`
	CollectLogs             param.Field[bool]   `json:"collect_logs,required"`
	Name                    param.Field[string] `json:"name,required"`
	Slug                    param.Field[string] `json:"slug,required"`
	RateLimitingInterval    param.Field[int64]  `json:"rate_limiting_interval"`
	RateLimitingLimit       param.Field[int64]  `json:"rate_limiting_limit"`
	RateLimitingTechnique   param.Field[string] `json:"rate_limiting_technique"`
}

func (AIGatewayNewParams) MarshalJSON 

func (r AIGatewayNewParams) MarshalJSON() (data []byte, err error)

type AIGatewayNewResponse 

type AIGatewayNewResponse struct {
	Task AIGatewayNewResponseTask `json:"task,required"`
	JSON aiGatewayNewResponseJSON `json:"-"`
}

func (*AIGatewayNewResponse) UnmarshalJSON 

func (r *AIGatewayNewResponse) UnmarshalJSON(data []byte) (err error)

type AIGatewayNewResponseEnvelope 

type AIGatewayNewResponseEnvelope struct {
	Result  AIGatewayNewResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    aiGatewayNewResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayNewResponseEnvelope) UnmarshalJSON 

func (r *AIGatewayNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AIGatewayNewResponseTask 

type AIGatewayNewResponseTask struct {
	ID                      string                       `json:"id,required" format:"uuid"`
	CacheInvalidateOnUpdate bool                         `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                        `json:"cache_ttl,required"`
	CollectLogs             bool                         `json:"collect_logs,required"`
	CreatedAt               time.Time                    `json:"created_at,required" format:"date-time"`
	ModifiedAt              time.Time                    `json:"modified_at,required" format:"date-time"`
	Name                    string                       `json:"name,required"`
	Slug                    string                       `json:"slug,required"`
	RateLimitingInterval    int64                        `json:"rate_limiting_interval"`
	RateLimitingLimit       int64                        `json:"rate_limiting_limit"`
	RateLimitingTechnique   string                       `json:"rate_limiting_technique"`
	JSON                    aiGatewayNewResponseTaskJSON `json:"-"`
}

func (*AIGatewayNewResponseTask) UnmarshalJSON 

func (r *AIGatewayNewResponseTask) UnmarshalJSON(data []byte) (err error)

type AIGatewayService 

type AIGatewayService struct {
	Options []option.RequestOption
	Logs    *LogService
}

AIGatewayService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAIGatewayService method instead.

func NewAIGatewayService 

func NewAIGatewayService(opts ...option.RequestOption) (r *AIGatewayService)

NewAIGatewayService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AIGatewayService) Delete 

func (r *AIGatewayService) Delete(ctx context.Context, id string, body AIGatewayDeleteParams, opts ...option.RequestOption) (res *AIGatewayDeleteResponse, err error)

Delete a Gateway

func (*AIGatewayService) Get 

func (r *AIGatewayService) Get(ctx context.Context, id string, query AIGatewayGetParams, opts ...option.RequestOption) (res *AIGatewayGetResponse, err error)

Fetch a Gateway

func (*AIGatewayService) List 

func (r *AIGatewayService) List(ctx context.Context, params AIGatewayListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[AIGatewayListResponse], err error)

List Gateway's

func (*AIGatewayService) ListAutoPaging 

func (r *AIGatewayService) ListAutoPaging(ctx context.Context, params AIGatewayListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[AIGatewayListResponse]

List Gateway's

func (*AIGatewayService) New 

func (r *AIGatewayService) New(ctx context.Context, params AIGatewayNewParams, opts ...option.RequestOption) (res *AIGatewayNewResponse, err error)

Create a new Gateway

func (*AIGatewayService) Update 

func (r *AIGatewayService) Update(ctx context.Context, id string, params AIGatewayUpdateParams, opts ...option.RequestOption) (res *AIGatewayUpdateResponse, err error)

Update a Gateway

type AIGatewayUpdateParams 

type AIGatewayUpdateParams struct {
	AccountID               param.Field[string] `path:"account_id,required"`
	CacheInvalidateOnUpdate param.Field[bool]   `json:"cache_invalidate_on_update,required"`
	CacheTTL                param.Field[int64]  `json:"cache_ttl,required"`
	CollectLogs             param.Field[bool]   `json:"collect_logs,required"`
	Name                    param.Field[string] `json:"name,required"`
	Slug                    param.Field[string] `json:"slug,required"`
	RateLimitingInterval    param.Field[int64]  `json:"rate_limiting_interval"`
	RateLimitingLimit       param.Field[int64]  `json:"rate_limiting_limit"`
	RateLimitingTechnique   param.Field[string] `json:"rate_limiting_technique"`
}

func (AIGatewayUpdateParams) MarshalJSON 

func (r AIGatewayUpdateParams) MarshalJSON() (data []byte, err error)

type AIGatewayUpdateResponse 

type AIGatewayUpdateResponse struct {
	ID                      string                      `json:"id,required" format:"uuid"`
	CacheInvalidateOnUpdate bool                        `json:"cache_invalidate_on_update,required"`
	CacheTTL                int64                       `json:"cache_ttl,required"`
	CollectLogs             bool                        `json:"collect_logs,required"`
	CreatedAt               time.Time                   `json:"created_at,required" format:"date-time"`
	ModifiedAt              time.Time                   `json:"modified_at,required" format:"date-time"`
	Name                    string                      `json:"name,required"`
	Slug                    string                      `json:"slug,required"`
	RateLimitingInterval    int64                       `json:"rate_limiting_interval"`
	RateLimitingLimit       int64                       `json:"rate_limiting_limit"`
	RateLimitingTechnique   string                      `json:"rate_limiting_technique"`
	JSON                    aiGatewayUpdateResponseJSON `json:"-"`
}

func (*AIGatewayUpdateResponse) UnmarshalJSON 

func (r *AIGatewayUpdateResponse) UnmarshalJSON(data []byte) (err error)

type AIGatewayUpdateResponseEnvelope 

type AIGatewayUpdateResponseEnvelope struct {
	Result  AIGatewayUpdateResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    aiGatewayUpdateResponseEnvelopeJSON `json:"-"`
}

func (*AIGatewayUpdateResponseEnvelope) UnmarshalJSON 

func (r *AIGatewayUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type LogGetParams 

type LogGetParams struct {
	AccountID param.Field[string]                `path:"account_id,required"`
	Cached    param.Field[bool]                  `query:"cached"`
	Direction param.Field[LogGetParamsDirection] `query:"direction"`
	EndDate   param.Field[time.Time]             `query:"end_date" format:"date-time"`
	OrderBy   param.Field[LogGetParamsOrderBy]   `query:"order_by"`
	Page      param.Field[int64]                 `query:"page"`
	PerPage   param.Field[int64]                 `query:"per_page"`
	Search    param.Field[string]                `query:"search"`
	StartDate param.Field[time.Time]             `query:"start_date" format:"date-time"`
	Success   param.Field[bool]                  `query:"success"`
}

func (LogGetParams) URLQuery 

func (r LogGetParams) URLQuery() (v url.Values)

URLQuery serializes LogGetParams's query parameters as `url.Values`.

type LogGetParamsDirection 

type LogGetParamsDirection string
const (
	LogGetParamsDirectionAsc  LogGetParamsDirection = "asc"
	LogGetParamsDirectionDesc LogGetParamsDirection = "desc"
)

func (LogGetParamsDirection) IsKnown 

func (r LogGetParamsDirection) IsKnown() bool

type LogGetParamsOrderBy 

type LogGetParamsOrderBy string
const (
	LogGetParamsOrderByCreatedAt LogGetParamsOrderBy = "created_at"
	LogGetParamsOrderByProvider  LogGetParamsOrderBy = "provider"
)

func (LogGetParamsOrderBy) IsKnown 

func (r LogGetParamsOrderBy) IsKnown() bool

type LogGetResponse 

type LogGetResponse struct {
	ID        string             `json:"id,required" format:"uuid"`
	Cached    bool               `json:"cached,required"`
	CreatedAt time.Time          `json:"created_at,required" format:"date-time"`
	Duration  int64              `json:"duration,required"`
	Model     string             `json:"model,required"`
	Path      string             `json:"path,required"`
	Provider  string             `json:"provider,required"`
	Request   string             `json:"request,required"`
	Response  string             `json:"response,required"`
	Success   bool               `json:"success,required"`
	TokensIn  int64              `json:"tokens_in,required"`
	TokensOut int64              `json:"tokens_out,required"`
	JSON      logGetResponseJSON `json:"-"`
}

func (*LogGetResponse) UnmarshalJSON 

func (r *LogGetResponse) UnmarshalJSON(data []byte) (err error)

type LogGetResponseEnvelope 

type LogGetResponseEnvelope struct {
	Result  []LogGetResponse           `json:"result,required"`
	Success bool                       `json:"success,required"`
	JSON    logGetResponseEnvelopeJSON `json:"-"`
}

func (*LogGetResponseEnvelope) UnmarshalJSON 

func (r *LogGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type LogService 

type LogService struct {
	Options []option.RequestOption
}

LogService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLogService method instead.

func NewLogService 

func NewLogService(opts ...option.RequestOption) (r *LogService)

NewLogService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*LogService) Get 

func (r *LogService) Get(ctx context.Context, id string, params LogGetParams, opts ...option.RequestOption) (res *[]LogGetResponse, err error)

List Gateway Logs

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberParam 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole 

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions 

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam 

type MemberUserParam = shared.MemberUserParam

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

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.