Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type IAMService
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type PermissionGroupGetParams
- type PermissionGroupGetResponse
- type PermissionGroupGetResponseMeta
- type PermissionGroupListParams
- type PermissionGroupListResponse
- type PermissionGroupListResponseMeta
- type PermissionGroupService
- func (r *PermissionGroupService) Get(ctx context.Context, permissionGroupID string, query PermissionGroupGetParams, ...) (res *PermissionGroupGetResponse, err error)
- func (r *PermissionGroupService) List(ctx context.Context, params PermissionGroupListParams, ...) (res *pagination.V4PagePaginationArray[PermissionGroupListResponse], err error)
- func (r *PermissionGroupService) ListAutoPaging(ctx context.Context, params PermissionGroupListParams, ...) *pagination.V4PagePaginationArrayAutoPager[PermissionGroupListResponse]
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResourceGroupDeleteParams
- type ResourceGroupDeleteResponse
- type ResourceGroupDeleteResponseEnvelope
- type ResourceGroupDeleteResponseEnvelopeErrors
- type ResourceGroupDeleteResponseEnvelopeErrorsSource
- type ResourceGroupDeleteResponseEnvelopeMessages
- type ResourceGroupDeleteResponseEnvelopeMessagesSource
- type ResourceGroupDeleteResponseEnvelopeSuccess
- type ResourceGroupGetParams
- type ResourceGroupGetResponse
- type ResourceGroupGetResponseMeta
- type ResourceGroupGetResponseScope
- type ResourceGroupGetResponseScopeObject
- type ResourceGroupListParams
- type ResourceGroupListResponse
- type ResourceGroupListResponseMeta
- type ResourceGroupListResponseScope
- type ResourceGroupListResponseScopeObject
- type ResourceGroupNewParams
- type ResourceGroupNewParamsScope
- type ResourceGroupNewParamsScopeObject
- type ResourceGroupNewResponse
- type ResourceGroupNewResponseScope
- type ResourceGroupNewResponseScopeObject
- type ResourceGroupService
- func (r *ResourceGroupService) Delete(ctx context.Context, resourceGroupID string, body ResourceGroupDeleteParams, ...) (res *ResourceGroupDeleteResponse, err error)
- func (r *ResourceGroupService) Get(ctx context.Context, resourceGroupID string, query ResourceGroupGetParams, ...) (res *ResourceGroupGetResponse, err error)
- func (r *ResourceGroupService) List(ctx context.Context, params ResourceGroupListParams, ...) (res *pagination.V4PagePaginationArray[ResourceGroupListResponse], err error)
- func (r *ResourceGroupService) ListAutoPaging(ctx context.Context, params ResourceGroupListParams, ...) *pagination.V4PagePaginationArrayAutoPager[ResourceGroupListResponse]
- func (r *ResourceGroupService) New(ctx context.Context, params ResourceGroupNewParams, ...) (res *ResourceGroupNewResponse, err error)
- func (r *ResourceGroupService) Update(ctx context.Context, resourceGroupID string, params ResourceGroupUpdateParams, ...) (res *ResourceGroupUpdateResponse, err error)
- type ResourceGroupUpdateParams
- type ResourceGroupUpdateParamsScope
- type ResourceGroupUpdateParamsScopeObject
- type ResourceGroupUpdateResponse
- type ResourceGroupUpdateResponseMeta
- type ResourceGroupUpdateResponseScope
- type ResourceGroupUpdateResponseScopeObject
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 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 ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type IAMService ¶
type IAMService struct {
Options []option.RequestOption
PermissionGroups *PermissionGroupService
ResourceGroups *ResourceGroupService
}
IAMService 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 NewIAMService method instead.
func NewIAMService ¶
func NewIAMService(opts ...option.RequestOption) (r *IAMService)
NewIAMService 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.
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 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 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 PermissionGroupGetResponse ¶
type PermissionGroupGetResponse struct {
// Identifier of the group.
ID string `json:"id,required"`
// Attributes associated to the permission group.
Meta PermissionGroupGetResponseMeta `json:"meta"`
// Name of the group.
Name string `json:"name"`
JSON permissionGroupGetResponseJSON `json:"-"`
}
A named group of permissions that map to a group of operations against resources.
func (*PermissionGroupGetResponse) UnmarshalJSON ¶
func (r *PermissionGroupGetResponse) UnmarshalJSON(data []byte) (err error)
type PermissionGroupGetResponseMeta ¶
type PermissionGroupGetResponseMeta struct {
Key string `json:"key"`
Value string `json:"value"`
JSON permissionGroupGetResponseMetaJSON `json:"-"`
}
Attributes associated to the permission group.
func (*PermissionGroupGetResponseMeta) UnmarshalJSON ¶
func (r *PermissionGroupGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type PermissionGroupListParams ¶
type PermissionGroupListParams struct {
// Account identifier tag.
AccountID param.Field[string] `path:"account_id,required"`
// ID of the permission group to be fetched.
ID param.Field[string] `query:"id"`
// Label of the permission group to be fetched.
Label param.Field[string] `query:"label"`
// Name of the permission group to be fetched.
Name param.Field[string] `query:"name"`
// Page number of paginated results.
Page param.Field[float64] `query:"page"`
// Maximum number of results per page.
PerPage param.Field[float64] `query:"per_page"`
}
func (PermissionGroupListParams) URLQuery ¶
func (r PermissionGroupListParams) URLQuery() (v url.Values)
URLQuery serializes PermissionGroupListParams's query parameters as `url.Values`.
type PermissionGroupListResponse ¶
type PermissionGroupListResponse struct {
// Identifier of the group.
ID string `json:"id,required"`
// Attributes associated to the permission group.
Meta PermissionGroupListResponseMeta `json:"meta"`
// Name of the group.
Name string `json:"name"`
JSON permissionGroupListResponseJSON `json:"-"`
}
A named group of permissions that map to a group of operations against resources.
func (*PermissionGroupListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *PermissionGroupListResponse) UnmarshalJSON(data []byte) (err error)
type PermissionGroupListResponseMeta ¶ added in v4.2.0
type PermissionGroupListResponseMeta struct {
Key string `json:"key"`
Value string `json:"value"`
JSON permissionGroupListResponseMetaJSON `json:"-"`
}
Attributes associated to the permission group.
func (*PermissionGroupListResponseMeta) UnmarshalJSON ¶ added in v4.2.0
func (r *PermissionGroupListResponseMeta) UnmarshalJSON(data []byte) (err error)
type PermissionGroupService ¶
type PermissionGroupService struct {
Options []option.RequestOption
}
PermissionGroupService 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 NewPermissionGroupService method instead.
func NewPermissionGroupService ¶
func NewPermissionGroupService(opts ...option.RequestOption) (r *PermissionGroupService)
NewPermissionGroupService 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 (*PermissionGroupService) Get ¶
func (r *PermissionGroupService) Get(ctx context.Context, permissionGroupID string, query PermissionGroupGetParams, opts ...option.RequestOption) (res *PermissionGroupGetResponse, err error)
Get information about a specific permission group in an account.
func (*PermissionGroupService) List ¶
func (r *PermissionGroupService) List(ctx context.Context, params PermissionGroupListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[PermissionGroupListResponse], err error)
List all the permissions groups for an account.
func (*PermissionGroupService) ListAutoPaging ¶
func (r *PermissionGroupService) ListAutoPaging(ctx context.Context, params PermissionGroupListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[PermissionGroupListResponse]
List all the permissions groups for an account.
type RatePlanID ¶ added in v4.1.0
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 ResourceGroupDeleteResponse ¶
type ResourceGroupDeleteResponse struct {
// Identifier
ID string `json:"id,required"`
JSON resourceGroupDeleteResponseJSON `json:"-"`
}
func (*ResourceGroupDeleteResponse) UnmarshalJSON ¶
func (r *ResourceGroupDeleteResponse) UnmarshalJSON(data []byte) (err error)
type ResourceGroupDeleteResponseEnvelope ¶
type ResourceGroupDeleteResponseEnvelope struct {
Errors []ResourceGroupDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []ResourceGroupDeleteResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ResourceGroupDeleteResponseEnvelopeSuccess `json:"success,required"`
Result ResourceGroupDeleteResponse `json:"result,nullable"`
JSON resourceGroupDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ResourceGroupDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ResourceGroupDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ResourceGroupDeleteResponseEnvelopeErrors ¶ added in v4.3.0
type ResourceGroupDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ResourceGroupDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON resourceGroupDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ResourceGroupDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ResourceGroupDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ResourceGroupDeleteResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ResourceGroupDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON resourceGroupDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ResourceGroupDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ResourceGroupDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ResourceGroupDeleteResponseEnvelopeMessages ¶ added in v4.3.0
type ResourceGroupDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ResourceGroupDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON resourceGroupDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ResourceGroupDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ResourceGroupDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ResourceGroupDeleteResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ResourceGroupDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON resourceGroupDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ResourceGroupDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ResourceGroupDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ResourceGroupDeleteResponseEnvelopeSuccess ¶
type ResourceGroupDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ResourceGroupDeleteResponseEnvelopeSuccessTrue ResourceGroupDeleteResponseEnvelopeSuccess = true
)
func (ResourceGroupDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r ResourceGroupDeleteResponseEnvelopeSuccess) IsKnown() bool
type ResourceGroupGetParams ¶
type ResourceGroupGetResponse ¶
type ResourceGroupGetResponse struct {
// Identifier of the group.
ID string `json:"id,required"`
// The scope associated to the resource group
Scope []ResourceGroupGetResponseScope `json:"scope,required"`
// Attributes associated to the resource group.
Meta ResourceGroupGetResponseMeta `json:"meta"`
// Name of the resource group.
Name string `json:"name"`
JSON resourceGroupGetResponseJSON `json:"-"`
}
A group of scoped resources.
func (*ResourceGroupGetResponse) UnmarshalJSON ¶
func (r *ResourceGroupGetResponse) UnmarshalJSON(data []byte) (err error)
type ResourceGroupGetResponseMeta ¶
type ResourceGroupGetResponseMeta struct {
Key string `json:"key"`
Value string `json:"value"`
JSON resourceGroupGetResponseMetaJSON `json:"-"`
}
Attributes associated to the resource group.
func (*ResourceGroupGetResponseMeta) UnmarshalJSON ¶
func (r *ResourceGroupGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type ResourceGroupGetResponseScope ¶
type ResourceGroupGetResponseScope struct {
// This is a combination of pre-defined resource name and identifier (like Account
// ID etc.)
Key string `json:"key,required"`
// A list of scope objects for additional context.
Objects []ResourceGroupGetResponseScopeObject `json:"objects,required"`
JSON resourceGroupGetResponseScopeJSON `json:"-"`
}
A scope is a combination of scope objects which provides additional context.
func (*ResourceGroupGetResponseScope) UnmarshalJSON ¶
func (r *ResourceGroupGetResponseScope) UnmarshalJSON(data []byte) (err error)
type ResourceGroupGetResponseScopeObject ¶
type ResourceGroupGetResponseScopeObject struct {
// This is a combination of pre-defined resource name and identifier (like Zone ID
// etc.)
Key string `json:"key,required"`
JSON resourceGroupGetResponseScopeObjectJSON `json:"-"`
}
A scope object represents any resource that can have actions applied against invite.
func (*ResourceGroupGetResponseScopeObject) UnmarshalJSON ¶
func (r *ResourceGroupGetResponseScopeObject) UnmarshalJSON(data []byte) (err error)
type ResourceGroupListParams ¶
type ResourceGroupListParams struct {
// Account identifier tag.
AccountID param.Field[string] `path:"account_id,required"`
// ID of the resource group to be fetched.
ID param.Field[string] `query:"id"`
// Name of the resource group to be fetched.
Name param.Field[string] `query:"name"`
// Page number of paginated results.
Page param.Field[float64] `query:"page"`
// Maximum number of results per page.
PerPage param.Field[float64] `query:"per_page"`
}
func (ResourceGroupListParams) URLQuery ¶
func (r ResourceGroupListParams) URLQuery() (v url.Values)
URLQuery serializes ResourceGroupListParams's query parameters as `url.Values`.
type ResourceGroupListResponse ¶
type ResourceGroupListResponse struct {
// Identifier of the group.
ID string `json:"id,required"`
// The scope associated to the resource group
Scope []ResourceGroupListResponseScope `json:"scope,required"`
// Attributes associated to the resource group.
Meta ResourceGroupListResponseMeta `json:"meta"`
// Name of the resource group.
Name string `json:"name"`
JSON resourceGroupListResponseJSON `json:"-"`
}
A group of scoped resources.
func (*ResourceGroupListResponse) UnmarshalJSON ¶ added in v4.2.0
func (r *ResourceGroupListResponse) UnmarshalJSON(data []byte) (err error)
type ResourceGroupListResponseMeta ¶ added in v4.2.0
type ResourceGroupListResponseMeta struct {
Key string `json:"key"`
Value string `json:"value"`
JSON resourceGroupListResponseMetaJSON `json:"-"`
}
Attributes associated to the resource group.
func (*ResourceGroupListResponseMeta) UnmarshalJSON ¶ added in v4.2.0
func (r *ResourceGroupListResponseMeta) UnmarshalJSON(data []byte) (err error)
type ResourceGroupListResponseScope ¶ added in v4.2.0
type ResourceGroupListResponseScope struct {
// This is a combination of pre-defined resource name and identifier (like Account
// ID etc.)
Key string `json:"key,required"`
// A list of scope objects for additional context.
Objects []ResourceGroupListResponseScopeObject `json:"objects,required"`
JSON resourceGroupListResponseScopeJSON `json:"-"`
}
A scope is a combination of scope objects which provides additional context.
func (*ResourceGroupListResponseScope) UnmarshalJSON ¶ added in v4.2.0
func (r *ResourceGroupListResponseScope) UnmarshalJSON(data []byte) (err error)
type ResourceGroupListResponseScopeObject ¶ added in v4.2.0
type ResourceGroupListResponseScopeObject struct {
// This is a combination of pre-defined resource name and identifier (like Zone ID
// etc.)
Key string `json:"key,required"`
JSON resourceGroupListResponseScopeObjectJSON `json:"-"`
}
A scope object represents any resource that can have actions applied against invite.
func (*ResourceGroupListResponseScopeObject) UnmarshalJSON ¶ added in v4.2.0
func (r *ResourceGroupListResponseScopeObject) UnmarshalJSON(data []byte) (err error)
type ResourceGroupNewParams ¶
type ResourceGroupNewParams struct {
// Account identifier tag.
AccountID param.Field[string] `path:"account_id,required"`
// Name of the resource group
Name param.Field[string] `json:"name,required"`
// A scope is a combination of scope objects which provides additional context.
Scope param.Field[ResourceGroupNewParamsScope] `json:"scope,required"`
}
func (ResourceGroupNewParams) MarshalJSON ¶
func (r ResourceGroupNewParams) MarshalJSON() (data []byte, err error)
type ResourceGroupNewParamsScope ¶
type ResourceGroupNewParamsScope struct {
// This is a combination of pre-defined resource name and identifier (like Account
// ID etc.)
Key param.Field[string] `json:"key,required"`
// A list of scope objects for additional context. The number of Scope objects
// should not be zero.
Objects param.Field[[]ResourceGroupNewParamsScopeObject] `json:"objects,required"`
}
A scope is a combination of scope objects which provides additional context.
func (ResourceGroupNewParamsScope) MarshalJSON ¶
func (r ResourceGroupNewParamsScope) MarshalJSON() (data []byte, err error)
type ResourceGroupNewParamsScopeObject ¶
type ResourceGroupNewParamsScopeObject struct {
// This is a combination of pre-defined resource name and identifier (like Zone ID
// etc.)
Key param.Field[string] `json:"key,required"`
}
A scope object represents any resource that can have actions applied against invite.
func (ResourceGroupNewParamsScopeObject) MarshalJSON ¶
func (r ResourceGroupNewParamsScopeObject) MarshalJSON() (data []byte, err error)
type ResourceGroupNewResponse ¶
type ResourceGroupNewResponse struct {
// Identifier of the group.
ID string `json:"id"`
// Attributes associated to the resource group.
Meta interface{} `json:"meta"`
// A scope is a combination of scope objects which provides additional context.
Scope ResourceGroupNewResponseScope `json:"scope"`
JSON resourceGroupNewResponseJSON `json:"-"`
}
A group of scoped resources.
func (*ResourceGroupNewResponse) UnmarshalJSON ¶
func (r *ResourceGroupNewResponse) UnmarshalJSON(data []byte) (err error)
type ResourceGroupNewResponseScope ¶
type ResourceGroupNewResponseScope struct {
// This is a combination of pre-defined resource name and identifier (like Account
// ID etc.)
Key string `json:"key,required"`
// A list of scope objects for additional context. The number of Scope objects
// should not be zero.
Objects []ResourceGroupNewResponseScopeObject `json:"objects,required"`
JSON resourceGroupNewResponseScopeJSON `json:"-"`
}
A scope is a combination of scope objects which provides additional context.
func (*ResourceGroupNewResponseScope) UnmarshalJSON ¶
func (r *ResourceGroupNewResponseScope) UnmarshalJSON(data []byte) (err error)
type ResourceGroupNewResponseScopeObject ¶
type ResourceGroupNewResponseScopeObject struct {
// This is a combination of pre-defined resource name and identifier (like Zone ID
// etc.)
Key string `json:"key,required"`
JSON resourceGroupNewResponseScopeObjectJSON `json:"-"`
}
A scope object represents any resource that can have actions applied against invite.
func (*ResourceGroupNewResponseScopeObject) UnmarshalJSON ¶
func (r *ResourceGroupNewResponseScopeObject) UnmarshalJSON(data []byte) (err error)
type ResourceGroupService ¶
type ResourceGroupService struct {
Options []option.RequestOption
}
ResourceGroupService 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 NewResourceGroupService method instead.
func NewResourceGroupService ¶
func NewResourceGroupService(opts ...option.RequestOption) (r *ResourceGroupService)
NewResourceGroupService 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 (*ResourceGroupService) Delete ¶
func (r *ResourceGroupService) Delete(ctx context.Context, resourceGroupID string, body ResourceGroupDeleteParams, opts ...option.RequestOption) (res *ResourceGroupDeleteResponse, err error)
Remove a resource group from an account.
func (*ResourceGroupService) Get ¶
func (r *ResourceGroupService) Get(ctx context.Context, resourceGroupID string, query ResourceGroupGetParams, opts ...option.RequestOption) (res *ResourceGroupGetResponse, err error)
Get information about a specific resource group in an account.
func (*ResourceGroupService) List ¶
func (r *ResourceGroupService) List(ctx context.Context, params ResourceGroupListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[ResourceGroupListResponse], err error)
List all the resource groups for an account.
func (*ResourceGroupService) ListAutoPaging ¶
func (r *ResourceGroupService) ListAutoPaging(ctx context.Context, params ResourceGroupListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[ResourceGroupListResponse]
List all the resource groups for an account.
func (*ResourceGroupService) New ¶
func (r *ResourceGroupService) New(ctx context.Context, params ResourceGroupNewParams, opts ...option.RequestOption) (res *ResourceGroupNewResponse, err error)
Create a new Resource Group under the specified account.
func (*ResourceGroupService) Update ¶
func (r *ResourceGroupService) Update(ctx context.Context, resourceGroupID string, params ResourceGroupUpdateParams, opts ...option.RequestOption) (res *ResourceGroupUpdateResponse, err error)
Modify an existing resource group.
type ResourceGroupUpdateParams ¶
type ResourceGroupUpdateParams struct {
// Account identifier tag.
AccountID param.Field[string] `path:"account_id,required"`
// Name of the resource group
Name param.Field[string] `json:"name"`
// A scope is a combination of scope objects which provides additional context.
Scope param.Field[ResourceGroupUpdateParamsScope] `json:"scope"`
}
func (ResourceGroupUpdateParams) MarshalJSON ¶
func (r ResourceGroupUpdateParams) MarshalJSON() (data []byte, err error)
type ResourceGroupUpdateParamsScope ¶
type ResourceGroupUpdateParamsScope struct {
// This is a combination of pre-defined resource name and identifier (like Account
// ID etc.)
Key param.Field[string] `json:"key,required"`
// A list of scope objects for additional context. The number of Scope objects
// should not be zero.
Objects param.Field[[]ResourceGroupUpdateParamsScopeObject] `json:"objects,required"`
}
A scope is a combination of scope objects which provides additional context.
func (ResourceGroupUpdateParamsScope) MarshalJSON ¶
func (r ResourceGroupUpdateParamsScope) MarshalJSON() (data []byte, err error)
type ResourceGroupUpdateParamsScopeObject ¶
type ResourceGroupUpdateParamsScopeObject struct {
// This is a combination of pre-defined resource name and identifier (like Zone ID
// etc.)
Key param.Field[string] `json:"key,required"`
}
A scope object represents any resource that can have actions applied against invite.
func (ResourceGroupUpdateParamsScopeObject) MarshalJSON ¶
func (r ResourceGroupUpdateParamsScopeObject) MarshalJSON() (data []byte, err error)
type ResourceGroupUpdateResponse ¶
type ResourceGroupUpdateResponse struct {
// Identifier of the group.
ID string `json:"id,required"`
// The scope associated to the resource group
Scope []ResourceGroupUpdateResponseScope `json:"scope,required"`
// Attributes associated to the resource group.
Meta ResourceGroupUpdateResponseMeta `json:"meta"`
// Name of the resource group.
Name string `json:"name"`
JSON resourceGroupUpdateResponseJSON `json:"-"`
}
A group of scoped resources.
func (*ResourceGroupUpdateResponse) UnmarshalJSON ¶
func (r *ResourceGroupUpdateResponse) UnmarshalJSON(data []byte) (err error)
type ResourceGroupUpdateResponseMeta ¶
type ResourceGroupUpdateResponseMeta struct {
Key string `json:"key"`
Value string `json:"value"`
JSON resourceGroupUpdateResponseMetaJSON `json:"-"`
}
Attributes associated to the resource group.
func (*ResourceGroupUpdateResponseMeta) UnmarshalJSON ¶
func (r *ResourceGroupUpdateResponseMeta) UnmarshalJSON(data []byte) (err error)
type ResourceGroupUpdateResponseScope ¶
type ResourceGroupUpdateResponseScope struct {
// This is a combination of pre-defined resource name and identifier (like Account
// ID etc.)
Key string `json:"key,required"`
// A list of scope objects for additional context.
Objects []ResourceGroupUpdateResponseScopeObject `json:"objects,required"`
JSON resourceGroupUpdateResponseScopeJSON `json:"-"`
}
A scope is a combination of scope objects which provides additional context.
func (*ResourceGroupUpdateResponseScope) UnmarshalJSON ¶
func (r *ResourceGroupUpdateResponseScope) UnmarshalJSON(data []byte) (err error)
type ResourceGroupUpdateResponseScopeObject ¶
type ResourceGroupUpdateResponseScopeObject struct {
// This is a combination of pre-defined resource name and identifier (like Zone ID
// etc.)
Key string `json:"key,required"`
JSON resourceGroupUpdateResponseScopeObjectJSON `json:"-"`
}
A scope object represents any resource that can have actions applied against invite.
func (*ResourceGroupUpdateResponseScopeObject) UnmarshalJSON ¶
func (r *ResourceGroupUpdateResponseScopeObject) UnmarshalJSON(data []byte) (err error)
type ResponseInfoSource ¶ added in v4.3.0
type ResponseInfoSource = shared.ResponseInfoSource
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 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 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 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 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.