consumerinvitation

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2021-08-01/consumerinvitation Documentation

The consumerinvitation SDK allows for interaction with Azure Resource Manager datashare (API Version 2021-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/datashare/2021-08-01/consumerinvitation"

Client Initialization

client := consumerinvitation.NewConsumerInvitationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConsumerInvitationClient.Get

ctx := context.TODO()
id := consumerinvitation.NewConsumerInvitationID("locationName", "invitationId")

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: ConsumerInvitationClient.ListInvitations

ctx := context.TODO()


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

Example Usage: ConsumerInvitationClient.RejectInvitation

ctx := context.TODO()
id := consumerinvitation.NewLocationID("locationName")

payload := consumerinvitation.ConsumerInvitation{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForInvitationStatus 

func PossibleValuesForInvitationStatus() []string

func ValidateConsumerInvitationID 

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

ValidateConsumerInvitationID checks that 'input' can be parsed as a Consumer Invitation ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type ConsumerInvitation 

type ConsumerInvitation struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties ConsumerInvitationProperties `json:"properties"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type ConsumerInvitationClient 

type ConsumerInvitationClient struct {
	Client *resourcemanager.Client
}

func NewConsumerInvitationClientWithBaseURI 

func NewConsumerInvitationClientWithBaseURI(sdkApi sdkEnv.Api) (*ConsumerInvitationClient, error)

func (ConsumerInvitationClient) Get 

func (c ConsumerInvitationClient) Get(ctx context.Context, id ConsumerInvitationId) (result GetOperationResponse, err error)

Get ...

func (ConsumerInvitationClient) ListInvitations 

func (c ConsumerInvitationClient) ListInvitations(ctx context.Context) (result ListInvitationsOperationResponse, err error)

ListInvitations ...

func (ConsumerInvitationClient) ListInvitationsComplete 

func (c ConsumerInvitationClient) ListInvitationsComplete(ctx context.Context) (ListInvitationsCompleteResult, error)

ListInvitationsComplete retrieves all the results into a single object

func (ConsumerInvitationClient) ListInvitationsCompleteMatchingPredicate 

func (c ConsumerInvitationClient) ListInvitationsCompleteMatchingPredicate(ctx context.Context, predicate ConsumerInvitationOperationPredicate) (result ListInvitationsCompleteResult, err error)

ListInvitationsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConsumerInvitationClient) RejectInvitation 

func (c ConsumerInvitationClient) RejectInvitation(ctx context.Context, id LocationId, input ConsumerInvitation) (result RejectInvitationOperationResponse, err error)

RejectInvitation ...

type ConsumerInvitationId 

type ConsumerInvitationId struct {
	LocationName string
	InvitationId string
}

ConsumerInvitationId is a struct representing the Resource ID for a Consumer Invitation

func NewConsumerInvitationID 

func NewConsumerInvitationID(locationName string, invitationId string) ConsumerInvitationId

NewConsumerInvitationID returns a new ConsumerInvitationId struct

func ParseConsumerInvitationID 

func ParseConsumerInvitationID(input string) (*ConsumerInvitationId, error)

ParseConsumerInvitationID parses 'input' into a ConsumerInvitationId

func ParseConsumerInvitationIDInsensitively 

func ParseConsumerInvitationIDInsensitively(input string) (*ConsumerInvitationId, error)

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

func (*ConsumerInvitationId) FromParseResult 

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

func (ConsumerInvitationId) ID 

func (id ConsumerInvitationId) ID() string

ID returns the formatted Consumer Invitation ID

func (ConsumerInvitationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Consumer Invitation ID

func (ConsumerInvitationId) String 

func (id ConsumerInvitationId) String() string

String returns a human-readable description of this Consumer Invitation ID

type ConsumerInvitationOperationPredicate 

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

func (ConsumerInvitationOperationPredicate) Matches 

func (p ConsumerInvitationOperationPredicate) Matches(input ConsumerInvitation) bool

type ConsumerInvitationProperties 

type ConsumerInvitationProperties struct {
	DataSetCount       *int64            `json:"dataSetCount,omitempty"`
	Description        *string           `json:"description,omitempty"`
	ExpirationDate     *string           `json:"expirationDate,omitempty"`
	InvitationId       string            `json:"invitationId"`
	InvitationStatus   *InvitationStatus `json:"invitationStatus,omitempty"`
	Location           *string           `json:"location,omitempty"`
	ProviderEmail      *string           `json:"providerEmail,omitempty"`
	ProviderName       *string           `json:"providerName,omitempty"`
	ProviderTenantName *string           `json:"providerTenantName,omitempty"`
	RespondedAt        *string           `json:"respondedAt,omitempty"`
	SentAt             *string           `json:"sentAt,omitempty"`
	ShareName          *string           `json:"shareName,omitempty"`
	TermsOfUse         *string           `json:"termsOfUse,omitempty"`
	UserEmail          *string           `json:"userEmail,omitempty"`
	UserName           *string           `json:"userName,omitempty"`
}

func (*ConsumerInvitationProperties) GetExpirationDateAsTime 

func (o *ConsumerInvitationProperties) GetExpirationDateAsTime() (*time.Time, error)

func (*ConsumerInvitationProperties) GetRespondedAtAsTime 

func (o *ConsumerInvitationProperties) GetRespondedAtAsTime() (*time.Time, error)

func (*ConsumerInvitationProperties) GetSentAtAsTime 

func (o *ConsumerInvitationProperties) GetSentAtAsTime() (*time.Time, error)

func (*ConsumerInvitationProperties) SetExpirationDateAsTime 

func (o *ConsumerInvitationProperties) SetExpirationDateAsTime(input time.Time)

func (*ConsumerInvitationProperties) SetRespondedAtAsTime 

func (o *ConsumerInvitationProperties) SetRespondedAtAsTime(input time.Time)

func (*ConsumerInvitationProperties) SetSentAtAsTime 

func (o *ConsumerInvitationProperties) SetSentAtAsTime(input time.Time)

type GetOperationResponse 

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

type InvitationStatus 

type InvitationStatus string
const (
	InvitationStatusAccepted  InvitationStatus = "Accepted"
	InvitationStatusPending   InvitationStatus = "Pending"
	InvitationStatusRejected  InvitationStatus = "Rejected"
	InvitationStatusWithdrawn InvitationStatus = "Withdrawn"
)

func (*InvitationStatus) UnmarshalJSON 

func (s *InvitationStatus) UnmarshalJSON(bytes []byte) error

type ListInvitationsCompleteResult 

type ListInvitationsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ConsumerInvitation
}

type ListInvitationsCustomPager added in v0.20240628.1153531 

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

type ListInvitationsOperationResponse 

type ListInvitationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ConsumerInvitation
}

type LocationId 

type LocationId struct {
	LocationName string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type RejectInvitationOperationResponse 

type RejectInvitationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConsumerInvitation
}

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.