url_normalization

Documentation

Index

• type Error
• type URLNormalizationGetParams
• type URLNormalizationGetResponse
  • func (r *URLNormalizationGetResponse) UnmarshalJSON(data []byte) (err error)
• type URLNormalizationService
  • func NewURLNormalizationService(opts ...option.RequestOption) (r *URLNormalizationService)
  • func (r *URLNormalizationService) Get(ctx context.Context, query URLNormalizationGetParams, ...) (res *URLNormalizationGetResponse, err error)
  • func (r *URLNormalizationService) Update(ctx context.Context, params URLNormalizationUpdateParams, ...) (res *URLNormalizationUpdateResponse, err error)
• type URLNormalizationUpdateParams
  • func (r URLNormalizationUpdateParams) MarshalJSON() (data []byte, err error)
• type URLNormalizationUpdateResponse
  • func (r *URLNormalizationUpdateResponse) UnmarshalJSON(data []byte) (err error)

Types

type Error

type Error = apierror.Error

type URLNormalizationGetParams

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

type URLNormalizationGetResponse

type URLNormalizationGetResponse struct {
	// The scope of the URL normalization.
	Scope string `json:"scope"`
	// The type of URL normalization performed by Cloudflare.
	Type string                          `json:"type"`
	JSON urlNormalizationGetResponseJSON `json:"-"`
}

func (*URLNormalizationGetResponse) UnmarshalJSON

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

type URLNormalizationService

type URLNormalizationService struct {
	Options []option.RequestOption
}

URLNormalizationService 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 NewURLNormalizationService method instead.

func NewURLNormalizationService

func NewURLNormalizationService(opts ...option.RequestOption) (r *URLNormalizationService)

NewURLNormalizationService 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 (*URLNormalizationService) Get

func (r *URLNormalizationService) Get(ctx context.Context, query URLNormalizationGetParams, opts ...option.RequestOption) (res *URLNormalizationGetResponse, err error)

Fetches the current URL normalization settings.

func (*URLNormalizationService) Update

func (r *URLNormalizationService) Update(ctx context.Context, params URLNormalizationUpdateParams, opts ...option.RequestOption) (res *URLNormalizationUpdateResponse, err error)

Updates the URL normalization settings.

type URLNormalizationUpdateParams

type URLNormalizationUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The scope of the URL normalization.
	Scope param.Field[string] `json:"scope"`
	// The type of URL normalization performed by Cloudflare.
	Type param.Field[string] `json:"type"`
}

func (URLNormalizationUpdateParams) MarshalJSON

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

type URLNormalizationUpdateResponse

type URLNormalizationUpdateResponse struct {
	// The scope of the URL normalization.
	Scope string `json:"scope"`
	// The type of URL normalization performed by Cloudflare.
	Type string                             `json:"type"`
	JSON urlNormalizationUpdateResponseJSON `json:"-"`
}

func (*URLNormalizationUpdateResponse) UnmarshalJSON

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