README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/automation/2015-10-31/jobstream
Documentation
The jobstream
SDK allows for interaction with the Azure Resource Manager Service automation
(API Version 2015-10-31
).
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/2015-10-31/jobstream"
Client Initialization
client := jobstream.NewJobStreamClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: JobStreamClient.Get
ctx := context.TODO()
id := jobstream.NewStreamID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "jobIdValue", "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: JobStreamClient.ListByJob
ctx := context.TODO()
id := jobstream.NewJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "jobIdValue")
// alternatively `client.ListByJob(ctx, id, jobstream.DefaultListByJobOperationOptions())` can be used to do batched pagination
items, err := client.ListByJobComplete(ctx, id, jobstream.DefaultListByJobOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForJobStreamType() []string
- func ValidateJobID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateStreamID(input interface{}, key string) (warnings []string, errors []error)
- type GetOperationResponse
- type JobId
- type JobStream
- type JobStreamClient
- func (c JobStreamClient) Get(ctx context.Context, id StreamId) (result GetOperationResponse, err error)
- func (c JobStreamClient) ListByJob(ctx context.Context, id JobId, options ListByJobOperationOptions) (resp ListByJobOperationResponse, err error)
- func (c JobStreamClient) ListByJobComplete(ctx context.Context, id JobId, options ListByJobOperationOptions) (ListByJobCompleteResult, error)
- func (c JobStreamClient) ListByJobCompleteMatchingPredicate(ctx context.Context, id JobId, options ListByJobOperationOptions, ...) (resp ListByJobCompleteResult, err error)
- type JobStreamOperationPredicate
- type JobStreamProperties
- type JobStreamType
- type ListByJobCompleteResult
- type ListByJobOperationOptions
- type ListByJobOperationResponse
- type StreamId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForJobStreamType ¶
func PossibleValuesForJobStreamType() []string
func ValidateJobID ¶
ValidateJobID checks that 'input' can be parsed as a Job ID
func ValidateStreamID ¶
ValidateStreamID checks that 'input' can be parsed as a Stream ID
Types ¶
type GetOperationResponse ¶
type JobId ¶
type JobId struct { SubscriptionId string ResourceGroupName string AutomationAccountName string JobId string }
JobId is a struct representing the Resource ID for a Job
func NewJobID ¶
func NewJobID(subscriptionId string, resourceGroupName string, automationAccountName string, jobId string) JobId
NewJobID returns a new JobId struct
func ParseJobID ¶
ParseJobID parses 'input' into a JobId
func ParseJobIDInsensitively ¶
ParseJobIDInsensitively parses 'input' case-insensitively into a JobId note: this method should only be used for API response data and not user input
func (JobId) Segments ¶
func (id JobId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Job ID
type JobStream ¶
type JobStream struct { Id *string `json:"id,omitempty"` Properties *JobStreamProperties `json:"properties,omitempty"` }
type JobStreamClient ¶
func NewJobStreamClientWithBaseURI ¶
func NewJobStreamClientWithBaseURI(endpoint string) JobStreamClient
func (JobStreamClient) Get ¶
func (c JobStreamClient) Get(ctx context.Context, id StreamId) (result GetOperationResponse, err error)
Get ...
func (JobStreamClient) ListByJob ¶
func (c JobStreamClient) ListByJob(ctx context.Context, id JobId, options ListByJobOperationOptions) (resp ListByJobOperationResponse, err error)
ListByJob ...
func (JobStreamClient) ListByJobComplete ¶
func (c JobStreamClient) ListByJobComplete(ctx context.Context, id JobId, options ListByJobOperationOptions) (ListByJobCompleteResult, error)
ListByJobComplete retrieves all of the results into a single object
func (JobStreamClient) ListByJobCompleteMatchingPredicate ¶
func (c JobStreamClient) ListByJobCompleteMatchingPredicate(ctx context.Context, id JobId, options ListByJobOperationOptions, predicate JobStreamOperationPredicate) (resp ListByJobCompleteResult, err error)
ListByJobCompleteMatchingPredicate retrieves all of the results and then applied the predicate
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 ListByJobCompleteResult ¶
type ListByJobCompleteResult struct {
Items []JobStream
}
type ListByJobOperationOptions ¶
type ListByJobOperationOptions struct {
Filter *string
}
func DefaultListByJobOperationOptions ¶
func DefaultListByJobOperationOptions() ListByJobOperationOptions
type ListByJobOperationResponse ¶
type ListByJobOperationResponse struct { HttpResponse *http.Response Model *[]JobStream // contains filtered or unexported fields }
func (ListByJobOperationResponse) HasMore ¶
func (r ListByJobOperationResponse) HasMore() bool
func (ListByJobOperationResponse) LoadMore ¶
func (r ListByJobOperationResponse) LoadMore(ctx context.Context) (resp ListByJobOperationResponse, err error)
type StreamId ¶
type StreamId struct { SubscriptionId string ResourceGroupName string AutomationAccountName string JobId string JobStreamId string }
StreamId is a struct representing the Resource ID for a Stream
func NewStreamID ¶
func NewStreamID(subscriptionId string, resourceGroupName string, automationAccountName string, jobId string, jobStreamId string) StreamId
NewStreamID returns a new StreamId struct
func ParseStreamID ¶
ParseStreamID parses 'input' into a StreamId
func ParseStreamIDInsensitively ¶
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) Segments ¶
func (id StreamId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Stream ID