apiissueattachment

package
v0.20231019.1113326 Latest Latest
Warning

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

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

README

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

The apiissueattachment SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-03-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-03-01-preview/apiissueattachment"

Client Initialization

client := apiissueattachment.NewApiIssueAttachmentClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiIssueAttachmentClient.CreateOrUpdate

ctx := context.TODO()
id := apiissueattachment.NewAttachmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "attachmentIdValue")

payload := apiissueattachment.IssueAttachmentContract{
	// ...
}


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

Example Usage: ApiIssueAttachmentClient.Delete

ctx := context.TODO()
id := apiissueattachment.NewAttachmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "attachmentIdValue")

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

Example Usage: ApiIssueAttachmentClient.Get

ctx := context.TODO()
id := apiissueattachment.NewAttachmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "attachmentIdValue")

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

Example Usage: ApiIssueAttachmentClient.GetEntityTag

ctx := context.TODO()
id := apiissueattachment.NewAttachmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue", "attachmentIdValue")

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

Example Usage: ApiIssueAttachmentClient.ListByService

ctx := context.TODO()
id := apiissueattachment.NewApiIssueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "apiIdValue", "issueIdValue")

// alternatively `client.ListByService(ctx, id, apiissueattachment.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, apiissueattachment.DefaultListByServiceOperationOptions())
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 ValidateApiIssueID 

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

ValidateApiIssueID checks that 'input' can be parsed as a Api Issue ID

func ValidateAttachmentID 

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

ValidateAttachmentID checks that 'input' can be parsed as a Attachment ID

Types

type ApiIssueAttachmentClient 

type ApiIssueAttachmentClient struct {
	Client *resourcemanager.Client
}

func NewApiIssueAttachmentClientWithBaseURI 

func NewApiIssueAttachmentClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiIssueAttachmentClient, error)

func (ApiIssueAttachmentClient) CreateOrUpdate 

func (c ApiIssueAttachmentClient) CreateOrUpdate(ctx context.Context, id AttachmentId, input IssueAttachmentContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ApiIssueAttachmentClient) Delete 

func (c ApiIssueAttachmentClient) Delete(ctx context.Context, id AttachmentId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (ApiIssueAttachmentClient) Get 

func (c ApiIssueAttachmentClient) Get(ctx context.Context, id AttachmentId) (result GetOperationResponse, err error)

Get ...

func (ApiIssueAttachmentClient) GetEntityTag 

func (c ApiIssueAttachmentClient) GetEntityTag(ctx context.Context, id AttachmentId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (ApiIssueAttachmentClient) ListByService 

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

ListByService ...

func (ApiIssueAttachmentClient) ListByServiceComplete 

func (c ApiIssueAttachmentClient) ListByServiceComplete(ctx context.Context, id ApiIssueId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiIssueAttachmentClient) ListByServiceCompleteMatchingPredicate 

func (c ApiIssueAttachmentClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ApiIssueId, options ListByServiceOperationOptions, predicate IssueAttachmentContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApiIssueId 

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

ApiIssueId is a struct representing the Resource ID for a Api Issue

func NewApiIssueID 

func NewApiIssueID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, issueId string) ApiIssueId

NewApiIssueID returns a new ApiIssueId struct

func ParseApiIssueID 

func ParseApiIssueID(input string) (*ApiIssueId, error)

ParseApiIssueID parses 'input' into a ApiIssueId

func ParseApiIssueIDInsensitively 

func ParseApiIssueIDInsensitively(input string) (*ApiIssueId, error)

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

func (ApiIssueId) ID 

func (id ApiIssueId) ID() string

ID returns the formatted Api Issue ID

func (ApiIssueId) Segments 

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

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

func (ApiIssueId) String 

func (id ApiIssueId) String() string

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

type AttachmentId 

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

AttachmentId is a struct representing the Resource ID for a Attachment

func NewAttachmentID 

func NewAttachmentID(subscriptionId string, resourceGroupName string, serviceName string, apiId string, issueId string, attachmentId string) AttachmentId

NewAttachmentID returns a new AttachmentId struct

func ParseAttachmentID 

func ParseAttachmentID(input string) (*AttachmentId, error)

ParseAttachmentID parses 'input' into a AttachmentId

func ParseAttachmentIDInsensitively 

func ParseAttachmentIDInsensitively(input string) (*AttachmentId, error)

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

func (AttachmentId) ID 

func (id AttachmentId) ID() string

ID returns the formatted Attachment ID

func (AttachmentId) Segments 

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

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

func (AttachmentId) String 

func (id AttachmentId) String() string

String returns a human-readable description of this Attachment ID

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders 

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

func (CreateOrUpdateOperationOptions) ToOData 

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

func (CreateOrUpdateOperationOptions) ToQuery 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IssueAttachmentContract
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

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

func (DeleteOperationOptions) ToOData 

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

func (DeleteOperationOptions) ToQuery 

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

type DeleteOperationResponse 

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

type GetEntityTagOperationResponse 

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

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IssueAttachmentContract
}

type IssueAttachmentContract 

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

type IssueAttachmentContractOperationPredicate 

type IssueAttachmentContractOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (IssueAttachmentContractOperationPredicate) Matches 

func (p IssueAttachmentContractOperationPredicate) Matches(input IssueAttachmentContract) bool

type IssueAttachmentContractProperties 

type IssueAttachmentContractProperties struct {
	Content       string `json:"content"`
	ContentFormat string `json:"contentFormat"`
	Title         string `json:"title"`
}

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	Items []IssueAttachmentContract
}

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        *[]IssueAttachmentContract
}

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.