Documentation
¶
Index ¶
- type ContentService
- type Error
- type ErrorData
- type RuleListResponse
- type RuleService
- func (r *RuleService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], err error)
- func (r *RuleService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse]
- func (r *RuleService) Update(ctx context.Context, zoneIdentifier string, body RuleUpdateParams, ...) (res *[]RuleUpdateResponse, err error)
- type RuleUpdateParams
- type RuleUpdateParamsRule
- type RuleUpdateResponse
- type RuleUpdateResponseEnvelope
- type RuleUpdateResponseEnvelopeErrors
- type RuleUpdateResponseEnvelopeMessages
- type RuleUpdateResponseEnvelopeSuccess
- type Snippet
- type SnippetDeleteResponse
- type SnippetDeleteResponseArray
- type SnippetDeleteResponseEnvelope
- type SnippetDeleteResponseEnvelopeErrors
- type SnippetDeleteResponseEnvelopeMessages
- type SnippetDeleteResponseEnvelopeSuccess
- type SnippetGetResponseEnvelope
- type SnippetGetResponseEnvelopeErrors
- type SnippetGetResponseEnvelopeMessages
- type SnippetGetResponseEnvelopeSuccess
- type SnippetService
- func (r *SnippetService) Delete(ctx context.Context, zoneIdentifier string, snippetName string, ...) (res *SnippetDeleteResponse, err error)
- func (r *SnippetService) Get(ctx context.Context, zoneIdentifier string, snippetName string, ...) (res *Snippet, err error)
- func (r *SnippetService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[Snippet], err error)
- func (r *SnippetService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Snippet]
- func (r *SnippetService) Update(ctx context.Context, zoneIdentifier string, snippetName string, ...) (res *Snippet, err error)
- type SnippetUpdateParams
- type SnippetUpdateParamsMetadata
- type SnippetUpdateResponseEnvelope
- type SnippetUpdateResponseEnvelopeErrors
- type SnippetUpdateResponseEnvelopeMessages
- type SnippetUpdateResponseEnvelopeSuccess
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContentService ¶
type ContentService struct {
Options []option.RequestOption
}
ContentService 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 NewContentService method instead.
func NewContentService ¶
func NewContentService(opts ...option.RequestOption) (r *ContentService)
NewContentService 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 RuleListResponse ¶
type RuleListResponse struct {
Description string `json:"description"`
Enabled bool `json:"enabled"`
Expression string `json:"expression"`
// Snippet identifying name
SnippetName string `json:"snippet_name"`
JSON ruleListResponseJSON `json:"-"`
}
func (*RuleListResponse) UnmarshalJSON ¶
func (r *RuleListResponse) UnmarshalJSON(data []byte) (err error)
type RuleService ¶
type RuleService struct {
Options []option.RequestOption
}
RuleService 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 NewRuleService method instead.
func NewRuleService ¶
func NewRuleService(opts ...option.RequestOption) (r *RuleService)
NewRuleService 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 (*RuleService) List ¶
func (r *RuleService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], err error)
Rules
func (*RuleService) ListAutoPaging ¶
func (r *RuleService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse]
Rules
func (*RuleService) Update ¶
func (r *RuleService) Update(ctx context.Context, zoneIdentifier string, body RuleUpdateParams, opts ...option.RequestOption) (res *[]RuleUpdateResponse, err error)
Put Rules
type RuleUpdateParams ¶
type RuleUpdateParams struct {
// List of snippet rules
Rules param.Field[[]RuleUpdateParamsRule] `json:"rules"`
}
func (RuleUpdateParams) MarshalJSON ¶
func (r RuleUpdateParams) MarshalJSON() (data []byte, err error)
type RuleUpdateParamsRule ¶
type RuleUpdateParamsRule struct {
Description param.Field[string] `json:"description"`
Enabled param.Field[bool] `json:"enabled"`
Expression param.Field[string] `json:"expression"`
// Snippet identifying name
SnippetName param.Field[string] `json:"snippet_name"`
}
func (RuleUpdateParamsRule) MarshalJSON ¶
func (r RuleUpdateParamsRule) MarshalJSON() (data []byte, err error)
type RuleUpdateResponse ¶
type RuleUpdateResponse struct {
Description string `json:"description"`
Enabled bool `json:"enabled"`
Expression string `json:"expression"`
// Snippet identifying name
SnippetName string `json:"snippet_name"`
JSON ruleUpdateResponseJSON `json:"-"`
}
func (*RuleUpdateResponse) UnmarshalJSON ¶
func (r *RuleUpdateResponse) UnmarshalJSON(data []byte) (err error)
type RuleUpdateResponseEnvelope ¶
type RuleUpdateResponseEnvelope struct {
Errors []RuleUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []RuleUpdateResponseEnvelopeMessages `json:"messages,required"`
// List of snippet rules
Result []RuleUpdateResponse `json:"result,required"`
// Whether the API call was successful
Success RuleUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON ruleUpdateResponseEnvelopeJSON `json:"-"`
}
func (*RuleUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RuleUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RuleUpdateResponseEnvelopeErrors ¶
type RuleUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON ruleUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*RuleUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *RuleUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type RuleUpdateResponseEnvelopeMessages ¶
type RuleUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON ruleUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*RuleUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *RuleUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type RuleUpdateResponseEnvelopeSuccess ¶
type RuleUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RuleUpdateResponseEnvelopeSuccessTrue RuleUpdateResponseEnvelopeSuccess = true
)
func (RuleUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RuleUpdateResponseEnvelopeSuccess) IsKnown() bool
type Snippet ¶
type Snippet struct {
// Creation time of the snippet
CreatedOn string `json:"created_on"`
// Modification time of the snippet
ModifiedOn string `json:"modified_on"`
// Snippet identifying name
SnippetName string `json:"snippet_name"`
JSON snippetJSON `json:"-"`
}
Snippet Information
func (*Snippet) UnmarshalJSON ¶
type SnippetDeleteResponse ¶ added in v2.2.0
type SnippetDeleteResponse interface {
ImplementsSnippetsSnippetDeleteResponse()
}
Union satisfied by snippets.SnippetDeleteResponseUnknown, snippets.SnippetDeleteResponseArray or shared.UnionString.
type SnippetDeleteResponseArray ¶
type SnippetDeleteResponseArray []interface{}
func (SnippetDeleteResponseArray) ImplementsSnippetsSnippetDeleteResponse ¶
func (r SnippetDeleteResponseArray) ImplementsSnippetsSnippetDeleteResponse()
type SnippetDeleteResponseEnvelope ¶
type SnippetDeleteResponseEnvelope struct {
Errors []SnippetDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []SnippetDeleteResponseEnvelopeMessages `json:"messages,required"`
Result SnippetDeleteResponse `json:"result,required"`
// Whether the API call was successful
Success SnippetDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON snippetDeleteResponseEnvelopeJSON `json:"-"`
}
func (*SnippetDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SnippetDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SnippetDeleteResponseEnvelopeErrors ¶
type SnippetDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON snippetDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*SnippetDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SnippetDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SnippetDeleteResponseEnvelopeMessages ¶
type SnippetDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON snippetDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*SnippetDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SnippetDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SnippetDeleteResponseEnvelopeSuccess ¶
type SnippetDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SnippetDeleteResponseEnvelopeSuccessTrue SnippetDeleteResponseEnvelopeSuccess = true
)
func (SnippetDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SnippetDeleteResponseEnvelopeSuccess) IsKnown() bool
type SnippetGetResponseEnvelope ¶
type SnippetGetResponseEnvelope struct {
Errors []SnippetGetResponseEnvelopeErrors `json:"errors,required"`
Messages []SnippetGetResponseEnvelopeMessages `json:"messages,required"`
// Snippet Information
Result Snippet `json:"result,required"`
// Whether the API call was successful
Success SnippetGetResponseEnvelopeSuccess `json:"success,required"`
JSON snippetGetResponseEnvelopeJSON `json:"-"`
}
func (*SnippetGetResponseEnvelope) UnmarshalJSON ¶
func (r *SnippetGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SnippetGetResponseEnvelopeErrors ¶
type SnippetGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON snippetGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*SnippetGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SnippetGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SnippetGetResponseEnvelopeMessages ¶
type SnippetGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON snippetGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*SnippetGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SnippetGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SnippetGetResponseEnvelopeSuccess ¶
type SnippetGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SnippetGetResponseEnvelopeSuccessTrue SnippetGetResponseEnvelopeSuccess = true
)
func (SnippetGetResponseEnvelopeSuccess) IsKnown ¶
func (r SnippetGetResponseEnvelopeSuccess) IsKnown() bool
type SnippetService ¶
type SnippetService struct {
Options []option.RequestOption
Content *ContentService
Rules *RuleService
}
SnippetService 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 NewSnippetService method instead.
func NewSnippetService ¶
func NewSnippetService(opts ...option.RequestOption) (r *SnippetService)
NewSnippetService 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 (*SnippetService) Delete ¶
func (r *SnippetService) Delete(ctx context.Context, zoneIdentifier string, snippetName string, opts ...option.RequestOption) (res *SnippetDeleteResponse, err error)
Delete Snippet
func (*SnippetService) Get ¶
func (r *SnippetService) Get(ctx context.Context, zoneIdentifier string, snippetName string, opts ...option.RequestOption) (res *Snippet, err error)
Snippet
func (*SnippetService) List ¶
func (r *SnippetService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[Snippet], err error)
All Snippets
func (*SnippetService) ListAutoPaging ¶
func (r *SnippetService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Snippet]
All Snippets
func (*SnippetService) Update ¶
func (r *SnippetService) Update(ctx context.Context, zoneIdentifier string, snippetName string, body SnippetUpdateParams, opts ...option.RequestOption) (res *Snippet, err error)
Put Snippet
type SnippetUpdateParams ¶
type SnippetUpdateParams struct {
// Content files of uploaded snippet
Files param.Field[string] `json:"files"`
Metadata param.Field[SnippetUpdateParamsMetadata] `json:"metadata"`
}
func (SnippetUpdateParams) MarshalJSON ¶
func (r SnippetUpdateParams) MarshalJSON() (data []byte, err error)
type SnippetUpdateParamsMetadata ¶
type SnippetUpdateParamsMetadata struct {
// Main module name of uploaded snippet
MainModule param.Field[string] `json:"main_module"`
}
func (SnippetUpdateParamsMetadata) MarshalJSON ¶
func (r SnippetUpdateParamsMetadata) MarshalJSON() (data []byte, err error)
type SnippetUpdateResponseEnvelope ¶
type SnippetUpdateResponseEnvelope struct {
Errors []SnippetUpdateResponseEnvelopeErrors `json:"errors,required"`
Messages []SnippetUpdateResponseEnvelopeMessages `json:"messages,required"`
// Snippet Information
Result Snippet `json:"result,required"`
// Whether the API call was successful
Success SnippetUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON snippetUpdateResponseEnvelopeJSON `json:"-"`
}
func (*SnippetUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SnippetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SnippetUpdateResponseEnvelopeErrors ¶
type SnippetUpdateResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON snippetUpdateResponseEnvelopeErrorsJSON `json:"-"`
}
func (*SnippetUpdateResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *SnippetUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type SnippetUpdateResponseEnvelopeMessages ¶
type SnippetUpdateResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON snippetUpdateResponseEnvelopeMessagesJSON `json:"-"`
}
func (*SnippetUpdateResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *SnippetUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type SnippetUpdateResponseEnvelopeSuccess ¶
type SnippetUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SnippetUpdateResponseEnvelopeSuccessTrue SnippetUpdateResponseEnvelopeSuccess = true
)
func (SnippetUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SnippetUpdateResponseEnvelopeSuccess) IsKnown() bool