pipelineruns

package
v0.20230622.1085613 Latest Latest
Warning

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

Go to latest
Published: Jun 22, 2023 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerregistry/2021-08-01-preview/pipelineruns Documentation

The pipelineruns SDK allows for interaction with the Azure Resource Manager Service containerregistry (API Version 2021-08-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/containerregistry/2021-08-01-preview/pipelineruns"

Client Initialization

client := pipelineruns.NewPipelineRunsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PipelineRunsClient.Create

ctx := context.TODO()
id := pipelineruns.NewPipelineRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "pipelineRunValue")

payload := pipelineruns.PipelineRun{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: PipelineRunsClient.Delete

ctx := context.TODO()
id := pipelineruns.NewPipelineRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "pipelineRunValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PipelineRunsClient.Get

ctx := context.TODO()
id := pipelineruns.NewPipelineRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue", "pipelineRunValue")

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: PipelineRunsClient.List

ctx := context.TODO()
id := pipelineruns.NewRegistryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "registryValue")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(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 PossibleValuesForPipelineRunSourceType

func PossibleValuesForPipelineRunSourceType() []string

func PossibleValuesForPipelineRunTargetType

func PossibleValuesForPipelineRunTargetType() []string

func PossibleValuesForPipelineSourceType

func PossibleValuesForPipelineSourceType() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidatePipelineRunID

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

ValidatePipelineRunID checks that 'input' can be parsed as a Pipeline Run ID

func ValidateRegistryID

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

ValidateRegistryID checks that 'input' can be parsed as a Registry ID

Types

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse

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

type ExportPipelineTargetProperties

type ExportPipelineTargetProperties struct {
	KeyVaultUri string  `json:"keyVaultUri"`
	Type        *string `json:"type,omitempty"`
	Uri         *string `json:"uri,omitempty"`
}

type GetOperationResponse

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

type ImportPipelineSourceProperties

type ImportPipelineSourceProperties struct {
	KeyVaultUri string              `json:"keyVaultUri"`
	Type        *PipelineSourceType `json:"type,omitempty"`
	Uri         *string             `json:"uri,omitempty"`
}

type ListCompleteResult

type ListCompleteResult struct {
	Items []PipelineRun
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PipelineRun
}

type PipelineRun

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

type PipelineRunId

type PipelineRunId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
	PipelineRunName   string
}

PipelineRunId is a struct representing the Resource ID for a Pipeline Run

func NewPipelineRunID

func NewPipelineRunID(subscriptionId string, resourceGroupName string, registryName string, pipelineRunName string) PipelineRunId

NewPipelineRunID returns a new PipelineRunId struct

func ParsePipelineRunID

func ParsePipelineRunID(input string) (*PipelineRunId, error)

ParsePipelineRunID parses 'input' into a PipelineRunId

func ParsePipelineRunIDInsensitively

func ParsePipelineRunIDInsensitively(input string) (*PipelineRunId, error)

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

func (PipelineRunId) ID

func (id PipelineRunId) ID() string

ID returns the formatted Pipeline Run ID

func (PipelineRunId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Pipeline Run ID

func (PipelineRunId) String

func (id PipelineRunId) String() string

String returns a human-readable description of this Pipeline Run ID

type PipelineRunOperationPredicate

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

func (PipelineRunOperationPredicate) Matches

type PipelineRunProperties

type PipelineRunProperties struct {
	ForceUpdateTag    *string              `json:"forceUpdateTag,omitempty"`
	ProvisioningState *ProvisioningState   `json:"provisioningState,omitempty"`
	Request           *PipelineRunRequest  `json:"request,omitempty"`
	Response          *PipelineRunResponse `json:"response,omitempty"`
}

type PipelineRunRequest

type PipelineRunRequest struct {
	Artifacts          *[]string                    `json:"artifacts,omitempty"`
	CatalogDigest      *string                      `json:"catalogDigest,omitempty"`
	PipelineResourceId *string                      `json:"pipelineResourceId,omitempty"`
	Source             *PipelineRunSourceProperties `json:"source,omitempty"`
	Target             *PipelineRunTargetProperties `json:"target,omitempty"`
}

type PipelineRunResponse

type PipelineRunResponse struct {
	CatalogDigest           *string                         `json:"catalogDigest,omitempty"`
	FinishTime              *string                         `json:"finishTime,omitempty"`
	ImportedArtifacts       *[]string                       `json:"importedArtifacts,omitempty"`
	PipelineRunErrorMessage *string                         `json:"pipelineRunErrorMessage,omitempty"`
	Progress                *ProgressProperties             `json:"progress,omitempty"`
	Source                  *ImportPipelineSourceProperties `json:"source,omitempty"`
	StartTime               *string                         `json:"startTime,omitempty"`
	Status                  *string                         `json:"status,omitempty"`
	Target                  *ExportPipelineTargetProperties `json:"target,omitempty"`
	Trigger                 *PipelineTriggerDescriptor      `json:"trigger,omitempty"`
}

func (*PipelineRunResponse) GetFinishTimeAsTime

func (o *PipelineRunResponse) GetFinishTimeAsTime() (*time.Time, error)

func (*PipelineRunResponse) GetStartTimeAsTime

func (o *PipelineRunResponse) GetStartTimeAsTime() (*time.Time, error)

func (*PipelineRunResponse) SetFinishTimeAsTime

func (o *PipelineRunResponse) SetFinishTimeAsTime(input time.Time)

func (*PipelineRunResponse) SetStartTimeAsTime

func (o *PipelineRunResponse) SetStartTimeAsTime(input time.Time)

type PipelineRunSourceProperties

type PipelineRunSourceProperties struct {
	Name *string                `json:"name,omitempty"`
	Type *PipelineRunSourceType `json:"type,omitempty"`
}

type PipelineRunSourceType

type PipelineRunSourceType string
const (
	PipelineRunSourceTypeAzureStorageBlob PipelineRunSourceType = "AzureStorageBlob"
)

func (*PipelineRunSourceType) UnmarshalJSON added in v0.20230406.1124617

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

type PipelineRunTargetProperties

type PipelineRunTargetProperties struct {
	Name *string                `json:"name,omitempty"`
	Type *PipelineRunTargetType `json:"type,omitempty"`
}

type PipelineRunTargetType

type PipelineRunTargetType string
const (
	PipelineRunTargetTypeAzureStorageBlob PipelineRunTargetType = "AzureStorageBlob"
)

func (*PipelineRunTargetType) UnmarshalJSON added in v0.20230406.1124617

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

type PipelineRunsClient

type PipelineRunsClient struct {
	Client *resourcemanager.Client
}

func NewPipelineRunsClientWithBaseURI

func NewPipelineRunsClientWithBaseURI(api environments.Api) (*PipelineRunsClient, error)

func (PipelineRunsClient) Create

Create ...

func (PipelineRunsClient) CreateThenPoll

func (c PipelineRunsClient) CreateThenPoll(ctx context.Context, id PipelineRunId, input PipelineRun) error

CreateThenPoll performs Create then polls until it's completed

func (PipelineRunsClient) Delete

Delete ...

func (PipelineRunsClient) DeleteThenPoll

func (c PipelineRunsClient) DeleteThenPoll(ctx context.Context, id PipelineRunId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PipelineRunsClient) Get

Get ...

func (PipelineRunsClient) List

List ...

func (PipelineRunsClient) ListComplete

ListComplete retrieves all the results into a single object

func (PipelineRunsClient) ListCompleteMatchingPredicate

func (c PipelineRunsClient) ListCompleteMatchingPredicate(ctx context.Context, id RegistryId, predicate PipelineRunOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PipelineSourceTriggerDescriptor

type PipelineSourceTriggerDescriptor struct {
	Timestamp *string `json:"timestamp,omitempty"`
}

func (*PipelineSourceTriggerDescriptor) GetTimestampAsTime

func (o *PipelineSourceTriggerDescriptor) GetTimestampAsTime() (*time.Time, error)

func (*PipelineSourceTriggerDescriptor) SetTimestampAsTime

func (o *PipelineSourceTriggerDescriptor) SetTimestampAsTime(input time.Time)

type PipelineSourceType

type PipelineSourceType string
const (
	PipelineSourceTypeAzureStorageBlobContainer PipelineSourceType = "AzureStorageBlobContainer"
)

func (*PipelineSourceType) UnmarshalJSON added in v0.20230406.1124617

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

type PipelineTriggerDescriptor

type PipelineTriggerDescriptor struct {
	SourceTrigger *PipelineSourceTriggerDescriptor `json:"sourceTrigger,omitempty"`
}

type ProgressProperties

type ProgressProperties struct {
	Percentage *string `json:"percentage,omitempty"`
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20230406.1124617

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

type RegistryId

type RegistryId struct {
	SubscriptionId    string
	ResourceGroupName string
	RegistryName      string
}

RegistryId is a struct representing the Resource ID for a Registry

func NewRegistryID

func NewRegistryID(subscriptionId string, resourceGroupName string, registryName string) RegistryId

NewRegistryID returns a new RegistryId struct

func ParseRegistryID

func ParseRegistryID(input string) (*RegistryId, error)

ParseRegistryID parses 'input' into a RegistryId

func ParseRegistryIDInsensitively

func ParseRegistryIDInsensitively(input string) (*RegistryId, error)

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

func (RegistryId) ID

func (id RegistryId) ID() string

ID returns the formatted Registry ID

func (RegistryId) Segments

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

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

func (RegistryId) String

func (id RegistryId) String() string

String returns a human-readable description of this Registry ID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL