google_tag_gateway

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 CloudflareTunnelConfigSrc ¶

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection ¶

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus ¶

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

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 Config ¶

type Config struct {
	// Enables or disables Google Tag Gateway for this zone.
	Enabled bool `json:"enabled" api:"required"`
	// Specifies the endpoint path for proxying Google Tag Manager requests. Use an
	// absolute path starting with '/', with no nested paths and alphanumeric
	// characters only (e.g. /metrics).
	Endpoint string `json:"endpoint" api:"required"`
	// Hides the original client IP address from Google when enabled.
	HideOriginalIP bool `json:"hideOriginalIp" api:"required"`
	// Specify the Google Tag Manager container or measurement ID (e.g. GTM-XXXXXXX or
	// G-XXXXXXXXXX).
	MeasurementID string `json:"measurementId" api:"required"`
	// Set up the associated Google Tag on the zone automatically when enabled.
	SetUpTag bool       `json:"setUpTag" api:"nullable"`
	JSON     configJSON `json:"-"`
}

Google Tag Gateway configuration for a zone.

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

type ConfigGetParams ¶

type ConfigGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type ConfigGetResponseEnvelope ¶

type ConfigGetResponseEnvelope struct {
	Errors   []ConfigGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ConfigGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ConfigGetResponseEnvelopeSuccess `json:"success" api:"required"`
	// Google Tag Gateway configuration for a zone.
	Result Config                        `json:"result"`
	JSON   configGetResponseEnvelopeJSON `json:"-"`
}

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

type ConfigGetResponseEnvelopeErrors ¶

type ConfigGetResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code" api:"required"`
	Message          string                                `json:"message" api:"required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           ConfigGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             configGetResponseEnvelopeErrorsJSON   `json:"-"`
}

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

type ConfigGetResponseEnvelopeErrorsSource ¶

type ConfigGetResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    configGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

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

type ConfigGetResponseEnvelopeMessages ¶

type ConfigGetResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code" api:"required"`
	Message          string                                  `json:"message" api:"required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           ConfigGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             configGetResponseEnvelopeMessagesJSON   `json:"-"`
}

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

type ConfigGetResponseEnvelopeMessagesSource ¶

type ConfigGetResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    configGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

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

type ConfigGetResponseEnvelopeSuccess ¶

type ConfigGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ConfigGetResponseEnvelopeSuccessTrue ConfigGetResponseEnvelopeSuccess = true
)

func (r ConfigGetResponseEnvelopeSuccess) IsKnown() bool

type ConfigParam ¶

type ConfigParam struct {
	// Enables or disables Google Tag Gateway for this zone.
	Enabled param.Field[bool] `json:"enabled" api:"required"`
	// Specifies the endpoint path for proxying Google Tag Manager requests. Use an
	// absolute path starting with '/', with no nested paths and alphanumeric
	// characters only (e.g. /metrics).
	Endpoint param.Field[string] `json:"endpoint" api:"required"`
	// Hides the original client IP address from Google when enabled.
	HideOriginalIP param.Field[bool] `json:"hideOriginalIp" api:"required"`
	// Specify the Google Tag Manager container or measurement ID (e.g. GTM-XXXXXXX or
	// G-XXXXXXXXXX).
	MeasurementID param.Field[string] `json:"measurementId" api:"required"`
	// Set up the associated Google Tag on the zone automatically when enabled.
	SetUpTag param.Field[bool] `json:"setUpTag"`
}

Google Tag Gateway configuration for a zone.

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

type ConfigService ¶

type ConfigService struct {
	Options []option.RequestOption
}

ConfigService 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 NewConfigService method instead.

func NewConfigService(opts ...option.RequestOption) (r *ConfigService)

func (r *ConfigService) Get(ctx context.Context, query ConfigGetParams, opts ...option.RequestOption) (res *Config, err error)

func (r *ConfigService) Update(ctx context.Context, params ConfigUpdateParams, opts ...option.RequestOption) (res *Config, err error)

type ConfigUpdateParams ¶

type ConfigUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
	// Google Tag Gateway configuration for a zone.
	Config ConfigParam `json:"config" api:"required"`
}

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

type ConfigUpdateResponseEnvelope ¶

type ConfigUpdateResponseEnvelope struct {
	Errors   []ConfigUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []ConfigUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success ConfigUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	// Google Tag Gateway configuration for a zone.
	Result Config                           `json:"result"`
	JSON   configUpdateResponseEnvelopeJSON `json:"-"`
}

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

type ConfigUpdateResponseEnvelopeErrors ¶

type ConfigUpdateResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           ConfigUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             configUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

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

type ConfigUpdateResponseEnvelopeErrorsSource ¶

type ConfigUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    configUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

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

type ConfigUpdateResponseEnvelopeMessages ¶

type ConfigUpdateResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ConfigUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             configUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

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

type ConfigUpdateResponseEnvelopeMessagesSource ¶

type ConfigUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    configUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

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

type ConfigUpdateResponseEnvelopeSuccess ¶

type ConfigUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ConfigUpdateResponseEnvelopeSuccessTrue ConfigUpdateResponseEnvelopeSuccess = true
)

func (r ConfigUpdateResponseEnvelopeSuccess) IsKnown() bool

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource ¶

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type GoogleTagGatewayService ¶

type GoogleTagGatewayService struct {
	Options []option.RequestOption
	Config  *ConfigService
}

GoogleTagGatewayService 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 NewGoogleTagGatewayService method instead.

func NewGoogleTagGatewayService(opts ...option.RequestOption) (r *GoogleTagGatewayService)

type Member ¶

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess ¶

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup ¶

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta ¶

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup ¶

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta ¶

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope ¶

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject ¶

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy ¶

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus ¶

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser ¶

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

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 RatePlan ¶

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID ¶

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam ¶

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo ¶

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource ¶

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role ¶

type Role = shared.Role

This is an alias to an internal type.

type RoleParam ¶

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions ¶

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam ¶

type RolePermissionsParam = shared.RolePermissionsParam

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.

type Subscription ¶

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency ¶

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam ¶

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState ¶

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token ¶

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition ¶

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList ¶

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam ¶

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam ¶

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP ¶

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam ¶

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam ¶

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy ¶

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect ¶

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam ¶

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup ¶

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam ¶

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta ¶

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam ¶

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString ¶

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion ¶

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam ¶

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus ¶

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue ¶

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.