testjobstream

package
v0.20230309.1111645 Latest Latest
Warning

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

Go to latest
Published: Mar 9, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2022-08-08/testjobstream Documentation

The testjobstream SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2022-08-08).

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/automation/2022-08-08/testjobstream"

Client Initialization

client := testjobstream.NewTestJobStreamClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TestJobStreamClient.Get

ctx := context.TODO()
id := testjobstream.NewStreamID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "jobValue", "jobStreamIdValue")

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: TestJobStreamClient.ListByTestJob

ctx := context.TODO()
id := testjobstream.NewRunbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "runbookValue")

// alternatively `client.ListByTestJob(ctx, id, testjobstream.DefaultListByTestJobOperationOptions())` can be used to do batched pagination
items, err := client.ListByTestJobComplete(ctx, id, testjobstream.DefaultListByTestJobOperationOptions())
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 PossibleValuesForJobStreamType

func PossibleValuesForJobStreamType() []string

func ValidateRunbookID

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

ValidateRunbookID checks that 'input' can be parsed as a Runbook ID

func ValidateStreamID

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

ValidateStreamID checks that 'input' can be parsed as a Stream ID

Types

type GetOperationResponse

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

type JobStream

type JobStream struct {
	Id         *string              `json:"id,omitempty"`
	Properties *JobStreamProperties `json:"properties,omitempty"`
}

type JobStreamOperationPredicate

type JobStreamOperationPredicate struct {
	Id *string
}

func (JobStreamOperationPredicate) Matches

func (p JobStreamOperationPredicate) Matches(input JobStream) bool

type JobStreamProperties

type JobStreamProperties struct {
	JobStreamId *string                 `json:"jobStreamId,omitempty"`
	StreamText  *string                 `json:"streamText,omitempty"`
	StreamType  *JobStreamType          `json:"streamType,omitempty"`
	Summary     *string                 `json:"summary,omitempty"`
	Time        *string                 `json:"time,omitempty"`
	Value       *map[string]interface{} `json:"value,omitempty"`
}

func (*JobStreamProperties) GetTimeAsTime

func (o *JobStreamProperties) GetTimeAsTime() (*time.Time, error)

func (*JobStreamProperties) SetTimeAsTime

func (o *JobStreamProperties) SetTimeAsTime(input time.Time)

type JobStreamType

type JobStreamType string
const (
	JobStreamTypeAny      JobStreamType = "Any"
	JobStreamTypeDebug    JobStreamType = "Debug"
	JobStreamTypeError    JobStreamType = "Error"
	JobStreamTypeOutput   JobStreamType = "Output"
	JobStreamTypeProgress JobStreamType = "Progress"
	JobStreamTypeVerbose  JobStreamType = "Verbose"
	JobStreamTypeWarning  JobStreamType = "Warning"
)

type ListByTestJobCompleteResult

type ListByTestJobCompleteResult struct {
	Items []JobStream
}

type ListByTestJobOperationOptions

type ListByTestJobOperationOptions struct {
	Filter *string
}

func DefaultListByTestJobOperationOptions

func DefaultListByTestJobOperationOptions() ListByTestJobOperationOptions

func (ListByTestJobOperationOptions) ToHeaders added in v0.20230216.1112329

func (ListByTestJobOperationOptions) ToOData added in v0.20230216.1112329

func (ListByTestJobOperationOptions) ToQuery added in v0.20230216.1112329

type ListByTestJobOperationResponse

type ListByTestJobOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]JobStream
}

type RunbookId

type RunbookId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	RunbookName           string
}

RunbookId is a struct representing the Resource ID for a Runbook

func NewRunbookID

func NewRunbookID(subscriptionId string, resourceGroupName string, automationAccountName string, runbookName string) RunbookId

NewRunbookID returns a new RunbookId struct

func ParseRunbookID

func ParseRunbookID(input string) (*RunbookId, error)

ParseRunbookID parses 'input' into a RunbookId

func ParseRunbookIDInsensitively

func ParseRunbookIDInsensitively(input string) (*RunbookId, error)

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

func (RunbookId) ID

func (id RunbookId) ID() string

ID returns the formatted Runbook ID

func (RunbookId) Segments

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

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

func (RunbookId) String

func (id RunbookId) String() string

String returns a human-readable description of this Runbook ID

type StreamId

type StreamId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	JobName               string
	JobStreamId           string
}

StreamId is a struct representing the Resource ID for a Stream

func NewStreamID

func NewStreamID(subscriptionId string, resourceGroupName string, automationAccountName string, jobName string, jobStreamId string) StreamId

NewStreamID returns a new StreamId struct

func ParseStreamID

func ParseStreamID(input string) (*StreamId, error)

ParseStreamID parses 'input' into a StreamId

func ParseStreamIDInsensitively

func ParseStreamIDInsensitively(input string) (*StreamId, error)

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

func (StreamId) ID

func (id StreamId) ID() string

ID returns the formatted Stream ID

func (StreamId) Segments

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

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

func (StreamId) String

func (id StreamId) String() string

String returns a human-readable description of this Stream ID

type TestJobStreamClient

type TestJobStreamClient struct {
	Client *resourcemanager.Client
}

func NewTestJobStreamClientWithBaseURI

func NewTestJobStreamClientWithBaseURI(api environments.Api) (*TestJobStreamClient, error)

func (TestJobStreamClient) Get

Get ...

func (TestJobStreamClient) ListByTestJob

ListByTestJob ...

func (TestJobStreamClient) ListByTestJobComplete

ListByTestJobComplete retrieves all the results into a single object

func (TestJobStreamClient) ListByTestJobCompleteMatchingPredicate

func (c TestJobStreamClient) ListByTestJobCompleteMatchingPredicate(ctx context.Context, id RunbookId, options ListByTestJobOperationOptions, predicate JobStreamOperationPredicate) (result ListByTestJobCompleteResult, err error)

ListByTestJobCompleteMatchingPredicate retrieves all the results and then applies the predicate

Jump to

Keyboard shortcuts

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