apirevision

package
v0.20241009.1142232 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/apirevision Documentation

The apirevision SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2023-05-01-preview).

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/2023-05-01-preview/apirevision"

Client Initialization

client := apirevision.NewApiRevisionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiRevisionClient.ListByService

ctx := context.TODO()
id := apirevision.NewApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "apiId")

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

Example Usage: ApiRevisionClient.WorkspaceApiRevisionListByService

ctx := context.TODO()
id := apirevision.NewWorkspaceApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId", "apiId")

// alternatively `client.WorkspaceApiRevisionListByService(ctx, id, apirevision.DefaultWorkspaceApiRevisionListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.WorkspaceApiRevisionListByServiceComplete(ctx, id, apirevision.DefaultWorkspaceApiRevisionListByServiceOperationOptions())
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 ValidateApiID 

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

ValidateApiID checks that 'input' can be parsed as a Api ID

func ValidateWorkspaceApiID 

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

ValidateWorkspaceApiID checks that 'input' can be parsed as a Workspace Api ID

Types

type ApiId 

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

ApiId is a struct representing the Resource ID for a Api

func NewApiID 

func NewApiID(subscriptionId string, resourceGroupName string, serviceName string, apiId string) ApiId

NewApiID returns a new ApiId struct

func ParseApiID 

func ParseApiID(input string) (*ApiId, error)

ParseApiID parses 'input' into a ApiId

func ParseApiIDInsensitively 

func ParseApiIDInsensitively(input string) (*ApiId, error)

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

func (*ApiId) FromParseResult 

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

func (ApiId) ID 

func (id ApiId) ID() string

ID returns the formatted Api ID

func (ApiId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Api ID

func (ApiId) String 

func (id ApiId) String() string

String returns a human-readable description of this Api ID

type ApiRevisionClient 

type ApiRevisionClient struct {
	Client *resourcemanager.Client
}

func NewApiRevisionClientWithBaseURI 

func NewApiRevisionClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiRevisionClient, error)

func (ApiRevisionClient) ListByService 

func (c ApiRevisionClient) ListByService(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)

ListByService ...

func (ApiRevisionClient) ListByServiceComplete 

func (c ApiRevisionClient) ListByServiceComplete(ctx context.Context, id ApiId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiRevisionClient) ListByServiceCompleteMatchingPredicate 

func (c ApiRevisionClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiId, options ListByServiceOperationOptions, predicate ApiRevisionContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ApiRevisionClient) WorkspaceApiRevisionListByService 

func (c ApiRevisionClient) WorkspaceApiRevisionListByService(ctx context.Context, id WorkspaceApiId, options WorkspaceApiRevisionListByServiceOperationOptions) (result WorkspaceApiRevisionListByServiceOperationResponse, err error)

WorkspaceApiRevisionListByService ...

func (ApiRevisionClient) WorkspaceApiRevisionListByServiceComplete 

func (c ApiRevisionClient) WorkspaceApiRevisionListByServiceComplete(ctx context.Context, id WorkspaceApiId, options WorkspaceApiRevisionListByServiceOperationOptions) (WorkspaceApiRevisionListByServiceCompleteResult, error)

WorkspaceApiRevisionListByServiceComplete retrieves all the results into a single object

func (ApiRevisionClient) WorkspaceApiRevisionListByServiceCompleteMatchingPredicate 

func (c ApiRevisionClient) WorkspaceApiRevisionListByServiceCompleteMatchingPredicate(ctx context.Context, id WorkspaceApiId, options WorkspaceApiRevisionListByServiceOperationOptions, predicate ApiRevisionContractOperationPredicate) (result WorkspaceApiRevisionListByServiceCompleteResult, err error)

WorkspaceApiRevisionListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApiRevisionContract 

type ApiRevisionContract struct {
	ApiId           *string `json:"apiId,omitempty"`
	ApiRevision     *string `json:"apiRevision,omitempty"`
	CreatedDateTime *string `json:"createdDateTime,omitempty"`
	Description     *string `json:"description,omitempty"`
	IsCurrent       *bool   `json:"isCurrent,omitempty"`
	IsOnline        *bool   `json:"isOnline,omitempty"`
	PrivateURL      *string `json:"privateUrl,omitempty"`
	UpdatedDateTime *string `json:"updatedDateTime,omitempty"`
}

func (*ApiRevisionContract) GetCreatedDateTimeAsTime 

func (o *ApiRevisionContract) GetCreatedDateTimeAsTime() (*time.Time, error)

func (*ApiRevisionContract) GetUpdatedDateTimeAsTime 

func (o *ApiRevisionContract) GetUpdatedDateTimeAsTime() (*time.Time, error)

func (*ApiRevisionContract) SetCreatedDateTimeAsTime 

func (o *ApiRevisionContract) SetCreatedDateTimeAsTime(input time.Time)

func (*ApiRevisionContract) SetUpdatedDateTimeAsTime 

func (o *ApiRevisionContract) SetUpdatedDateTimeAsTime(input time.Time)

type ApiRevisionContractOperationPredicate 

type ApiRevisionContractOperationPredicate struct {
	ApiId           *string
	ApiRevision     *string
	CreatedDateTime *string
	Description     *string
	IsCurrent       *bool
	IsOnline        *bool
	PrivateURL      *string
	UpdatedDateTime *string
}

func (ApiRevisionContractOperationPredicate) Matches 

func (p ApiRevisionContractOperationPredicate) Matches(input ApiRevisionContract) bool

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiRevisionContract
}

type ListByServiceCustomPager added in v0.20240628.1153531 

type ListByServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByServiceCustomPager) NextPageLink() *odata.Link

type ListByServiceOperationOptions 

type ListByServiceOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultListByServiceOperationOptions 

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders 

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

func (ListByServiceOperationOptions) ToOData 

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

func (ListByServiceOperationOptions) ToQuery 

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

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiRevisionContract
}

type WorkspaceApiId 

type WorkspaceApiId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
	ApiId             string
}

WorkspaceApiId is a struct representing the Resource ID for a Workspace Api

func NewWorkspaceApiID 

func NewWorkspaceApiID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string, apiId string) WorkspaceApiId

NewWorkspaceApiID returns a new WorkspaceApiId struct

func ParseWorkspaceApiID 

func ParseWorkspaceApiID(input string) (*WorkspaceApiId, error)

ParseWorkspaceApiID parses 'input' into a WorkspaceApiId

func ParseWorkspaceApiIDInsensitively 

func ParseWorkspaceApiIDInsensitively(input string) (*WorkspaceApiId, error)

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

func (*WorkspaceApiId) FromParseResult 

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

func (WorkspaceApiId) ID 

func (id WorkspaceApiId) ID() string

ID returns the formatted Workspace Api ID

func (WorkspaceApiId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace Api ID

func (WorkspaceApiId) String 

func (id WorkspaceApiId) String() string

String returns a human-readable description of this Workspace Api ID

type WorkspaceApiRevisionListByServiceCompleteResult 

type WorkspaceApiRevisionListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiRevisionContract
}

type WorkspaceApiRevisionListByServiceCustomPager added in v0.20240628.1153531 

type WorkspaceApiRevisionListByServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *WorkspaceApiRevisionListByServiceCustomPager) NextPageLink() *odata.Link

type WorkspaceApiRevisionListByServiceOperationOptions 

type WorkspaceApiRevisionListByServiceOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultWorkspaceApiRevisionListByServiceOperationOptions 

func DefaultWorkspaceApiRevisionListByServiceOperationOptions() WorkspaceApiRevisionListByServiceOperationOptions

func (WorkspaceApiRevisionListByServiceOperationOptions) ToHeaders 

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

func (WorkspaceApiRevisionListByServiceOperationOptions) ToOData 

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

func (WorkspaceApiRevisionListByServiceOperationOptions) ToQuery 

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

type WorkspaceApiRevisionListByServiceOperationResponse 

type WorkspaceApiRevisionListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiRevisionContract
}

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.