contenttypecontentitem

package
v0.20240214.1100807 Latest Latest
Warning

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

 Go to latest Published: Feb 14, 2024 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/contenttypecontentitem Documentation

The contenttypecontentitem SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2022-08-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/contenttypecontentitem"

Client Initialization

client := contenttypecontentitem.NewContentTypeContentItemClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContentTypeContentItemClient.ContentItemCreateOrUpdate

ctx := context.TODO()
id := contenttypecontentitem.NewContentItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "contentTypeIdValue", "contentItemIdValue")

payload := contenttypecontentitem.ContentItemContract{
	// ...
}


read, err := client.ContentItemCreateOrUpdate(ctx, id, payload, contenttypecontentitem.DefaultContentItemCreateOrUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContentTypeContentItemClient.ContentItemDelete

ctx := context.TODO()
id := contenttypecontentitem.NewContentItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "contentTypeIdValue", "contentItemIdValue")

read, err := client.ContentItemDelete(ctx, id, contenttypecontentitem.DefaultContentItemDeleteOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContentTypeContentItemClient.ContentItemGet

ctx := context.TODO()
id := contenttypecontentitem.NewContentItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "contentTypeIdValue", "contentItemIdValue")

read, err := client.ContentItemGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContentTypeContentItemClient.ContentItemGetEntityTag

ctx := context.TODO()
id := contenttypecontentitem.NewContentItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "contentTypeIdValue", "contentItemIdValue")

read, err := client.ContentItemGetEntityTag(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContentTypeContentItemClient.ContentItemListByService

ctx := context.TODO()
id := contenttypecontentitem.NewContentTypeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "contentTypeIdValue")

// alternatively `client.ContentItemListByService(ctx, id)` can be used to do batched pagination
items, err := client.ContentItemListByServiceComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateContentItemID 

func ValidateContentItemID(input interface{}, key string) (warnings []string, errors []error)

ValidateContentItemID checks that 'input' can be parsed as a Content Item ID

func ValidateContentTypeID 

func ValidateContentTypeID(input interface{}, key string) (warnings []string, errors []error)

ValidateContentTypeID checks that 'input' can be parsed as a Content Type ID

Types

type ContentItemContract 

type ContentItemContract struct {
	Id         *string      `json:"id,omitempty"`
	Name       *string      `json:"name,omitempty"`
	Properties *interface{} `json:"properties,omitempty"`
	Type       *string      `json:"type,omitempty"`
}

type ContentItemContractOperationPredicate 

type ContentItemContractOperationPredicate struct {
	Id         *string
	Name       *string
	Properties *interface{}
	Type       *string
}

func (ContentItemContractOperationPredicate) Matches 

func (p ContentItemContractOperationPredicate) Matches(input ContentItemContract) bool

type ContentItemCreateOrUpdateOperationOptions 

type ContentItemCreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultContentItemCreateOrUpdateOperationOptions 

func DefaultContentItemCreateOrUpdateOperationOptions() ContentItemCreateOrUpdateOperationOptions

func (ContentItemCreateOrUpdateOperationOptions) ToHeaders 

func (o ContentItemCreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (ContentItemCreateOrUpdateOperationOptions) ToOData 

func (o ContentItemCreateOrUpdateOperationOptions) ToOData() *odata.Query

func (ContentItemCreateOrUpdateOperationOptions) ToQuery 

func (o ContentItemCreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type ContentItemCreateOrUpdateOperationResponse 

type ContentItemCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContentItemContract
}

type ContentItemDeleteOperationOptions 

type ContentItemDeleteOperationOptions struct {
	IfMatch *string
}

func DefaultContentItemDeleteOperationOptions 

func DefaultContentItemDeleteOperationOptions() ContentItemDeleteOperationOptions

func (ContentItemDeleteOperationOptions) ToHeaders 

func (o ContentItemDeleteOperationOptions) ToHeaders() *client.Headers

func (ContentItemDeleteOperationOptions) ToOData 

func (o ContentItemDeleteOperationOptions) ToOData() *odata.Query

func (ContentItemDeleteOperationOptions) ToQuery 

func (o ContentItemDeleteOperationOptions) ToQuery() *client.QueryParams

type ContentItemDeleteOperationResponse 

type ContentItemDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ContentItemGetEntityTagOperationResponse 

type ContentItemGetEntityTagOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ContentItemGetOperationResponse 

type ContentItemGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContentItemContract
}

type ContentItemId 

type ContentItemId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ContentTypeId     string
	ContentItemId     string
}

ContentItemId is a struct representing the Resource ID for a Content Item

func NewContentItemID 

func NewContentItemID(subscriptionId string, resourceGroupName string, serviceName string, contentTypeId string, contentItemId string) ContentItemId

NewContentItemID returns a new ContentItemId struct

func ParseContentItemID 

func ParseContentItemID(input string) (*ContentItemId, error)

ParseContentItemID parses 'input' into a ContentItemId

func ParseContentItemIDInsensitively 

func ParseContentItemIDInsensitively(input string) (*ContentItemId, error)

ParseContentItemIDInsensitively parses 'input' case-insensitively into a ContentItemId note: this method should only be used for API response data and not user input

func (*ContentItemId) FromParseResult 

func (id *ContentItemId) FromParseResult(input resourceids.ParseResult) error

func (ContentItemId) ID 

func (id ContentItemId) ID() string

ID returns the formatted Content Item ID

func (ContentItemId) Segments 

func (id ContentItemId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Content Item ID

func (ContentItemId) String 

func (id ContentItemId) String() string

String returns a human-readable description of this Content Item ID

type ContentItemListByServiceCompleteResult 

type ContentItemListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ContentItemContract
}

type ContentItemListByServiceOperationResponse 

type ContentItemListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ContentItemContract
}

type ContentTypeContentItemClient 

type ContentTypeContentItemClient struct {
	Client *resourcemanager.Client
}

func NewContentTypeContentItemClientWithBaseURI 

func NewContentTypeContentItemClientWithBaseURI(sdkApi sdkEnv.Api) (*ContentTypeContentItemClient, error)

func (ContentTypeContentItemClient) ContentItemCreateOrUpdate 

func (c ContentTypeContentItemClient) ContentItemCreateOrUpdate(ctx context.Context, id ContentItemId, input ContentItemContract, options ContentItemCreateOrUpdateOperationOptions) (result ContentItemCreateOrUpdateOperationResponse, err error)

ContentItemCreateOrUpdate ...

func (ContentTypeContentItemClient) ContentItemDelete 

func (c ContentTypeContentItemClient) ContentItemDelete(ctx context.Context, id ContentItemId, options ContentItemDeleteOperationOptions) (result ContentItemDeleteOperationResponse, err error)

ContentItemDelete ...

func (ContentTypeContentItemClient) ContentItemGet 

func (c ContentTypeContentItemClient) ContentItemGet(ctx context.Context, id ContentItemId) (result ContentItemGetOperationResponse, err error)

ContentItemGet ...

func (ContentTypeContentItemClient) ContentItemGetEntityTag 

func (c ContentTypeContentItemClient) ContentItemGetEntityTag(ctx context.Context, id ContentItemId) (result ContentItemGetEntityTagOperationResponse, err error)

ContentItemGetEntityTag ...

func (ContentTypeContentItemClient) ContentItemListByService 

func (c ContentTypeContentItemClient) ContentItemListByService(ctx context.Context, id ContentTypeId) (result ContentItemListByServiceOperationResponse, err error)

ContentItemListByService ...

func (ContentTypeContentItemClient) ContentItemListByServiceComplete 

func (c ContentTypeContentItemClient) ContentItemListByServiceComplete(ctx context.Context, id ContentTypeId) (ContentItemListByServiceCompleteResult, error)

ContentItemListByServiceComplete retrieves all the results into a single object

func (ContentTypeContentItemClient) ContentItemListByServiceCompleteMatchingPredicate 

func (c ContentTypeContentItemClient) ContentItemListByServiceCompleteMatchingPredicate(ctx context.Context, id ContentTypeId, predicate ContentItemContractOperationPredicate) (result ContentItemListByServiceCompleteResult, err error)

ContentItemListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ContentTypeId 

type ContentTypeId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	ContentTypeId     string
}

ContentTypeId is a struct representing the Resource ID for a Content Type

func NewContentTypeID 

func NewContentTypeID(subscriptionId string, resourceGroupName string, serviceName string, contentTypeId string) ContentTypeId

NewContentTypeID returns a new ContentTypeId struct

func ParseContentTypeID 

func ParseContentTypeID(input string) (*ContentTypeId, error)

ParseContentTypeID parses 'input' into a ContentTypeId

func ParseContentTypeIDInsensitively 

func ParseContentTypeIDInsensitively(input string) (*ContentTypeId, error)

ParseContentTypeIDInsensitively parses 'input' case-insensitively into a ContentTypeId note: this method should only be used for API response data and not user input

func (*ContentTypeId) FromParseResult 

func (id *ContentTypeId) FromParseResult(input resourceids.ParseResult) error

func (ContentTypeId) ID 

func (id ContentTypeId) ID() string

ID returns the formatted Content Type ID

func (ContentTypeId) Segments 

func (id ContentTypeId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Content Type ID

func (ContentTypeId) String 

func (id ContentTypeId) String() string

String returns a human-readable description of this Content Type ID

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.