testjobstream

package
v0.20240130.1181631 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2023-11-01/testjobstream Documentation

The testjobstream SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2023-11-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/automation/2023-11-01/testjobstream"

Client Initialization

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

Example Usage: TestJobStreamClient.Get

ctx := context.TODO()
id := testjobstream.NewTestJobStreamID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "runbookValue", "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 ValidateTestJobStreamID 

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

ValidateTestJobStreamID checks that 'input' can be parsed as a Test Job 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"
)

func (*JobStreamType) UnmarshalJSON 

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

type ListByTestJobCompleteResult 

type ListByTestJobCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []JobStream
}

type ListByTestJobOperationOptions 

type ListByTestJobOperationOptions struct {
	Filter *string
}

func DefaultListByTestJobOperationOptions 

func DefaultListByTestJobOperationOptions() ListByTestJobOperationOptions

func (ListByTestJobOperationOptions) ToHeaders 

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

func (ListByTestJobOperationOptions) ToOData 

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

func (ListByTestJobOperationOptions) ToQuery 

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

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) FromParseResult 

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

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 TestJobStreamClient 

type TestJobStreamClient struct {
	Client *resourcemanager.Client
}

func NewTestJobStreamClientWithBaseURI 

func NewTestJobStreamClientWithBaseURI(sdkApi sdkEnv.Api) (*TestJobStreamClient, error)

func (TestJobStreamClient) Get 

func (c TestJobStreamClient) Get(ctx context.Context, id TestJobStreamId) (result GetOperationResponse, err error)

Get ...

func (TestJobStreamClient) ListByTestJob 

func (c TestJobStreamClient) ListByTestJob(ctx context.Context, id RunbookId, options ListByTestJobOperationOptions) (result ListByTestJobOperationResponse, err error)

ListByTestJob ...

func (TestJobStreamClient) ListByTestJobComplete 

func (c TestJobStreamClient) ListByTestJobComplete(ctx context.Context, id RunbookId, options ListByTestJobOperationOptions) (ListByTestJobCompleteResult, error)

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

type TestJobStreamId 

type TestJobStreamId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	RunbookName           string
	JobStreamId           string
}

TestJobStreamId is a struct representing the Resource ID for a Test Job Stream

func NewTestJobStreamID 

func NewTestJobStreamID(subscriptionId string, resourceGroupName string, automationAccountName string, runbookName string, jobStreamId string) TestJobStreamId

NewTestJobStreamID returns a new TestJobStreamId struct

func ParseTestJobStreamID 

func ParseTestJobStreamID(input string) (*TestJobStreamId, error)

ParseTestJobStreamID parses 'input' into a TestJobStreamId

func ParseTestJobStreamIDInsensitively 

func ParseTestJobStreamIDInsensitively(input string) (*TestJobStreamId, error)

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

func (*TestJobStreamId) FromParseResult 

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

func (TestJobStreamId) ID 

func (id TestJobStreamId) ID() string

ID returns the formatted Test Job Stream ID

func (TestJobStreamId) Segments 

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

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

func (TestJobStreamId) String 

func (id TestJobStreamId) String() string

String returns a human-readable description of this Test Job Stream ID

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.