Documentation ¶
Overview ¶
Package livestream is an auto-generated package for the Live Stream API.
General documentation ¶
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.
Example usage ¶
To get started with this package, create a client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client ¶
The following is an example of making an API call with the newly created client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.CreateChannelRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#CreateChannelRequest. } op, err := c.CreateChannel(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context ¶
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Index ¶
- func DefaultAuthScopes() []string
- type CallOptions
- type ChannelIterator
- type Client
- func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreateChannel(ctx context.Context, req *livestreampb.CreateChannelRequest, ...) (*CreateChannelOperation, error)
- func (c *Client) CreateChannelOperation(name string) *CreateChannelOperation
- func (c *Client) CreateEvent(ctx context.Context, req *livestreampb.CreateEventRequest, ...) (*livestreampb.Event, error)
- func (c *Client) CreateInput(ctx context.Context, req *livestreampb.CreateInputRequest, ...) (*CreateInputOperation, error)
- func (c *Client) CreateInputOperation(name string) *CreateInputOperation
- func (c *Client) DeleteChannel(ctx context.Context, req *livestreampb.DeleteChannelRequest, ...) (*DeleteChannelOperation, error)
- func (c *Client) DeleteChannelOperation(name string) *DeleteChannelOperation
- func (c *Client) DeleteEvent(ctx context.Context, req *livestreampb.DeleteEventRequest, ...) error
- func (c *Client) DeleteInput(ctx context.Context, req *livestreampb.DeleteInputRequest, ...) (*DeleteInputOperation, error)
- func (c *Client) DeleteInputOperation(name string) *DeleteInputOperation
- func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *Client) GetChannel(ctx context.Context, req *livestreampb.GetChannelRequest, ...) (*livestreampb.Channel, error)
- func (c *Client) GetEvent(ctx context.Context, req *livestreampb.GetEventRequest, opts ...gax.CallOption) (*livestreampb.Event, error)
- func (c *Client) GetInput(ctx context.Context, req *livestreampb.GetInputRequest, opts ...gax.CallOption) (*livestreampb.Input, error)
- func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *Client) ListChannels(ctx context.Context, req *livestreampb.ListChannelsRequest, ...) *ChannelIterator
- func (c *Client) ListEvents(ctx context.Context, req *livestreampb.ListEventsRequest, ...) *EventIterator
- func (c *Client) ListInputs(ctx context.Context, req *livestreampb.ListInputsRequest, ...) *InputIterator
- func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *Client) StartChannel(ctx context.Context, req *livestreampb.StartChannelRequest, ...) (*StartChannelOperation, error)
- func (c *Client) StartChannelOperation(name string) *StartChannelOperation
- func (c *Client) StopChannel(ctx context.Context, req *livestreampb.StopChannelRequest, ...) (*StopChannelOperation, error)
- func (c *Client) StopChannelOperation(name string) *StopChannelOperation
- func (c *Client) UpdateChannel(ctx context.Context, req *livestreampb.UpdateChannelRequest, ...) (*UpdateChannelOperation, error)
- func (c *Client) UpdateChannelOperation(name string) *UpdateChannelOperation
- func (c *Client) UpdateInput(ctx context.Context, req *livestreampb.UpdateInputRequest, ...) (*UpdateInputOperation, error)
- func (c *Client) UpdateInputOperation(name string) *UpdateInputOperation
- type CreateChannelOperation
- func (op *CreateChannelOperation) Done() bool
- func (op *CreateChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *CreateChannelOperation) Name() string
- func (op *CreateChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
- func (op *CreateChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
- type CreateInputOperation
- func (op *CreateInputOperation) Done() bool
- func (op *CreateInputOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *CreateInputOperation) Name() string
- func (op *CreateInputOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
- func (op *CreateInputOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
- type DeleteChannelOperation
- func (op *DeleteChannelOperation) Done() bool
- func (op *DeleteChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *DeleteChannelOperation) Name() string
- func (op *DeleteChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteInputOperation
- func (op *DeleteInputOperation) Done() bool
- func (op *DeleteInputOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *DeleteInputOperation) Name() string
- func (op *DeleteInputOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteInputOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type EventIterator
- type InputIterator
- type LocationIterator
- type OperationIterator
- type StartChannelOperation
- func (op *StartChannelOperation) Done() bool
- func (op *StartChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *StartChannelOperation) Name() string
- func (op *StartChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
- func (op *StartChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
- type StopChannelOperation
- func (op *StopChannelOperation) Done() bool
- func (op *StopChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *StopChannelOperation) Name() string
- func (op *StopChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
- func (op *StopChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
- type UpdateChannelOperation
- func (op *UpdateChannelOperation) Done() bool
- func (op *UpdateChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *UpdateChannelOperation) Name() string
- func (op *UpdateChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
- func (op *UpdateChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
- type UpdateInputOperation
- func (op *UpdateInputOperation) Done() bool
- func (op *UpdateInputOperation) Metadata() (*livestreampb.OperationMetadata, error)
- func (op *UpdateInputOperation) Name() string
- func (op *UpdateInputOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
- func (op *UpdateInputOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
Examples ¶
- Client.CancelOperation
- Client.CreateChannel
- Client.CreateEvent
- Client.CreateInput
- Client.DeleteChannel
- Client.DeleteEvent
- Client.DeleteInput
- Client.DeleteOperation
- Client.GetChannel
- Client.GetEvent
- Client.GetInput
- Client.GetLocation
- Client.GetOperation
- Client.ListChannels
- Client.ListEvents
- Client.ListInputs
- Client.ListLocations
- Client.ListOperations
- Client.StartChannel
- Client.StopChannel
- Client.UpdateChannel
- Client.UpdateInput
- NewClient
- NewRESTClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type CallOptions ¶
type CallOptions struct { CreateChannel []gax.CallOption ListChannels []gax.CallOption GetChannel []gax.CallOption DeleteChannel []gax.CallOption UpdateChannel []gax.CallOption StartChannel []gax.CallOption StopChannel []gax.CallOption CreateInput []gax.CallOption ListInputs []gax.CallOption GetInput []gax.CallOption DeleteInput []gax.CallOption UpdateInput []gax.CallOption CreateEvent []gax.CallOption ListEvents []gax.CallOption GetEvent []gax.CallOption DeleteEvent []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
CallOptions contains the retry settings for each method of Client.
type ChannelIterator ¶
type ChannelIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*livestreampb.Channel, nextPageToken string, err error) // contains filtered or unexported fields }
ChannelIterator manages a stream of *livestreampb.Channel.
func (*ChannelIterator) Next ¶
func (it *ChannelIterator) Next() (*livestreampb.Channel, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ChannelIterator) PageInfo ¶
func (it *ChannelIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type Client ¶
type Client struct { // The call options for this service. CallOptions *CallOptions // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
Client is a client for interacting with Live Stream API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).
func NewClient ¶
NewClient creates a new livestream service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func NewRESTClient ¶ added in v1.12.0
NewRESTClient creates a new livestream service rest client.
Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewRESTClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*Client) CancelOperation ¶ added in v1.14.0
func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" livestream "cloud.google.com/go/video/livestream/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) Close ¶
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
deprecated
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) CreateChannel ¶
func (c *Client) CreateChannel(ctx context.Context, req *livestreampb.CreateChannelRequest, opts ...gax.CallOption) (*CreateChannelOperation, error)
CreateChannel creates a channel with the provided unique ID in the specified region.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.CreateChannelRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#CreateChannelRequest. } op, err := c.CreateChannel(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateChannelOperation ¶
func (c *Client) CreateChannelOperation(name string) *CreateChannelOperation
CreateChannelOperation returns a new CreateChannelOperation from a given name. The name must be that of a previously created CreateChannelOperation, possibly from a different process.
func (*Client) CreateEvent ¶
func (c *Client) CreateEvent(ctx context.Context, req *livestreampb.CreateEventRequest, opts ...gax.CallOption) (*livestreampb.Event, error)
CreateEvent creates an event with the provided unique ID in the specified channel.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.CreateEventRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#CreateEventRequest. } resp, err := c.CreateEvent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateInput ¶
func (c *Client) CreateInput(ctx context.Context, req *livestreampb.CreateInputRequest, opts ...gax.CallOption) (*CreateInputOperation, error)
CreateInput creates an input with the provided unique ID in the specified region.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.CreateInputRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#CreateInputRequest. } op, err := c.CreateInput(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateInputOperation ¶
func (c *Client) CreateInputOperation(name string) *CreateInputOperation
CreateInputOperation returns a new CreateInputOperation from a given name. The name must be that of a previously created CreateInputOperation, possibly from a different process.
func (*Client) DeleteChannel ¶
func (c *Client) DeleteChannel(ctx context.Context, req *livestreampb.DeleteChannelRequest, opts ...gax.CallOption) (*DeleteChannelOperation, error)
DeleteChannel deletes the specified channel.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.DeleteChannelRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#DeleteChannelRequest. } op, err := c.DeleteChannel(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteChannelOperation ¶
func (c *Client) DeleteChannelOperation(name string) *DeleteChannelOperation
DeleteChannelOperation returns a new DeleteChannelOperation from a given name. The name must be that of a previously created DeleteChannelOperation, possibly from a different process.
func (*Client) DeleteEvent ¶
func (c *Client) DeleteEvent(ctx context.Context, req *livestreampb.DeleteEventRequest, opts ...gax.CallOption) error
DeleteEvent deletes the specified event.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.DeleteEventRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#DeleteEventRequest. } err = c.DeleteEvent(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteInput ¶
func (c *Client) DeleteInput(ctx context.Context, req *livestreampb.DeleteInputRequest, opts ...gax.CallOption) (*DeleteInputOperation, error)
DeleteInput deletes the specified input.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.DeleteInputRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#DeleteInputRequest. } op, err := c.DeleteInput(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteInputOperation ¶
func (c *Client) DeleteInputOperation(name string) *DeleteInputOperation
DeleteInputOperation returns a new DeleteInputOperation from a given name. The name must be that of a previously created DeleteInputOperation, possibly from a different process.
func (*Client) DeleteOperation ¶ added in v1.14.0
func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" livestream "cloud.google.com/go/video/livestream/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) GetChannel ¶
func (c *Client) GetChannel(ctx context.Context, req *livestreampb.GetChannelRequest, opts ...gax.CallOption) (*livestreampb.Channel, error)
GetChannel returns the specified channel.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.GetChannelRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#GetChannelRequest. } resp, err := c.GetChannel(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetEvent ¶
func (c *Client) GetEvent(ctx context.Context, req *livestreampb.GetEventRequest, opts ...gax.CallOption) (*livestreampb.Event, error)
GetEvent returns the specified event.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.GetEventRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#GetEventRequest. } resp, err := c.GetEvent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetInput ¶
func (c *Client) GetInput(ctx context.Context, req *livestreampb.GetInputRequest, opts ...gax.CallOption) (*livestreampb.Input, error)
GetInput returns the specified input.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.GetInputRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#GetInputRequest. } resp, err := c.GetInput(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetLocation ¶ added in v1.14.0
func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetOperation ¶ added in v1.14.0
func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" livestream "cloud.google.com/go/video/livestream/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListChannels ¶
func (c *Client) ListChannels(ctx context.Context, req *livestreampb.ListChannelsRequest, opts ...gax.CallOption) *ChannelIterator
ListChannels returns a list of all channels in the specified region.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.ListChannelsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#ListChannelsRequest. } it := c.ListChannels(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListEvents ¶
func (c *Client) ListEvents(ctx context.Context, req *livestreampb.ListEventsRequest, opts ...gax.CallOption) *EventIterator
ListEvents returns a list of all events in the specified channel.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.ListEventsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#ListEventsRequest. } it := c.ListEvents(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListInputs ¶
func (c *Client) ListInputs(ctx context.Context, req *livestreampb.ListInputsRequest, opts ...gax.CallOption) *InputIterator
ListInputs returns a list of all inputs in the specified region.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.ListInputsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#ListInputsRequest. } it := c.ListInputs(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListLocations ¶ added in v1.14.0
func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListOperations ¶ added in v1.14.0
func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" livestream "cloud.google.com/go/video/livestream/apiv1" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) StartChannel ¶
func (c *Client) StartChannel(ctx context.Context, req *livestreampb.StartChannelRequest, opts ...gax.CallOption) (*StartChannelOperation, error)
StartChannel starts the specified channel. Part of the video pipeline will be created only when the StartChannel request is received by the server.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.StartChannelRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#StartChannelRequest. } op, err := c.StartChannel(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) StartChannelOperation ¶
func (c *Client) StartChannelOperation(name string) *StartChannelOperation
StartChannelOperation returns a new StartChannelOperation from a given name. The name must be that of a previously created StartChannelOperation, possibly from a different process.
func (*Client) StopChannel ¶
func (c *Client) StopChannel(ctx context.Context, req *livestreampb.StopChannelRequest, opts ...gax.CallOption) (*StopChannelOperation, error)
StopChannel stops the specified channel. Part of the video pipeline will be released when the StopChannel request is received by the server.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.StopChannelRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#StopChannelRequest. } op, err := c.StopChannel(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) StopChannelOperation ¶
func (c *Client) StopChannelOperation(name string) *StopChannelOperation
StopChannelOperation returns a new StopChannelOperation from a given name. The name must be that of a previously created StopChannelOperation, possibly from a different process.
func (*Client) UpdateChannel ¶
func (c *Client) UpdateChannel(ctx context.Context, req *livestreampb.UpdateChannelRequest, opts ...gax.CallOption) (*UpdateChannelOperation, error)
UpdateChannel updates the specified channel.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.UpdateChannelRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#UpdateChannelRequest. } op, err := c.UpdateChannel(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateChannelOperation ¶
func (c *Client) UpdateChannelOperation(name string) *UpdateChannelOperation
UpdateChannelOperation returns a new UpdateChannelOperation from a given name. The name must be that of a previously created UpdateChannelOperation, possibly from a different process.
func (*Client) UpdateInput ¶
func (c *Client) UpdateInput(ctx context.Context, req *livestreampb.UpdateInputRequest, opts ...gax.CallOption) (*UpdateInputOperation, error)
UpdateInput updates the specified input.
Example ¶
package main import ( "context" livestream "cloud.google.com/go/video/livestream/apiv1" livestreampb "cloud.google.com/go/video/livestream/apiv1/livestreampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := livestream.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &livestreampb.UpdateInputRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/video/livestream/apiv1/livestreampb#UpdateInputRequest. } op, err := c.UpdateInput(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateInputOperation ¶
func (c *Client) UpdateInputOperation(name string) *UpdateInputOperation
UpdateInputOperation returns a new UpdateInputOperation from a given name. The name must be that of a previously created UpdateInputOperation, possibly from a different process.
type CreateChannelOperation ¶
type CreateChannelOperation struct {
// contains filtered or unexported fields
}
CreateChannelOperation manages a long-running operation from CreateChannel.
func (*CreateChannelOperation) Done ¶
func (op *CreateChannelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateChannelOperation) Metadata ¶
func (op *CreateChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateChannelOperation) Name ¶
func (op *CreateChannelOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateChannelOperation) Poll ¶
func (op *CreateChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateChannelOperation) Wait ¶
func (op *CreateChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateInputOperation ¶
type CreateInputOperation struct {
// contains filtered or unexported fields
}
CreateInputOperation manages a long-running operation from CreateInput.
func (*CreateInputOperation) Done ¶
func (op *CreateInputOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateInputOperation) Metadata ¶
func (op *CreateInputOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateInputOperation) Name ¶
func (op *CreateInputOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateInputOperation) Poll ¶
func (op *CreateInputOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateInputOperation) Wait ¶
func (op *CreateInputOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteChannelOperation ¶
type DeleteChannelOperation struct {
// contains filtered or unexported fields
}
DeleteChannelOperation manages a long-running operation from DeleteChannel.
func (*DeleteChannelOperation) Done ¶
func (op *DeleteChannelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteChannelOperation) Metadata ¶
func (op *DeleteChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteChannelOperation) Name ¶
func (op *DeleteChannelOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteChannelOperation) Poll ¶
func (op *DeleteChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteChannelOperation) Wait ¶
func (op *DeleteChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteInputOperation ¶
type DeleteInputOperation struct {
// contains filtered or unexported fields
}
DeleteInputOperation manages a long-running operation from DeleteInput.
func (*DeleteInputOperation) Done ¶
func (op *DeleteInputOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteInputOperation) Metadata ¶
func (op *DeleteInputOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteInputOperation) Name ¶
func (op *DeleteInputOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteInputOperation) Poll ¶
func (op *DeleteInputOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteInputOperation) Wait ¶
func (op *DeleteInputOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type EventIterator ¶
type EventIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*livestreampb.Event, nextPageToken string, err error) // contains filtered or unexported fields }
EventIterator manages a stream of *livestreampb.Event.
func (*EventIterator) Next ¶
func (it *EventIterator) Next() (*livestreampb.Event, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EventIterator) PageInfo ¶
func (it *EventIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type InputIterator ¶
type InputIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*livestreampb.Input, nextPageToken string, err error) // contains filtered or unexported fields }
InputIterator manages a stream of *livestreampb.Input.
func (*InputIterator) Next ¶
func (it *InputIterator) Next() (*livestreampb.Input, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*InputIterator) PageInfo ¶
func (it *InputIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type LocationIterator ¶ added in v1.14.0
type LocationIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*locationpb.Location, nextPageToken string, err error) // contains filtered or unexported fields }
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) Next ¶ added in v1.14.0
func (it *LocationIterator) Next() (*locationpb.Location, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo ¶ added in v1.14.0
func (it *LocationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type OperationIterator ¶ added in v1.14.0
type OperationIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*longrunningpb.Operation, nextPageToken string, err error) // contains filtered or unexported fields }
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) Next ¶ added in v1.14.0
func (it *OperationIterator) Next() (*longrunningpb.Operation, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo ¶ added in v1.14.0
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type StartChannelOperation ¶
type StartChannelOperation struct {
// contains filtered or unexported fields
}
StartChannelOperation manages a long-running operation from StartChannel.
func (*StartChannelOperation) Done ¶
func (op *StartChannelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*StartChannelOperation) Metadata ¶
func (op *StartChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*StartChannelOperation) Name ¶
func (op *StartChannelOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StartChannelOperation) Poll ¶
func (op *StartChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*StartChannelOperation) Wait ¶
func (op *StartChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type StopChannelOperation ¶
type StopChannelOperation struct {
// contains filtered or unexported fields
}
StopChannelOperation manages a long-running operation from StopChannel.
func (*StopChannelOperation) Done ¶
func (op *StopChannelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*StopChannelOperation) Metadata ¶
func (op *StopChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*StopChannelOperation) Name ¶
func (op *StopChannelOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*StopChannelOperation) Poll ¶
func (op *StopChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*StopChannelOperation) Wait ¶
func (op *StopChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.ChannelOperationResponse, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateChannelOperation ¶
type UpdateChannelOperation struct {
// contains filtered or unexported fields
}
UpdateChannelOperation manages a long-running operation from UpdateChannel.
func (*UpdateChannelOperation) Done ¶
func (op *UpdateChannelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateChannelOperation) Metadata ¶
func (op *UpdateChannelOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateChannelOperation) Name ¶
func (op *UpdateChannelOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateChannelOperation) Poll ¶
func (op *UpdateChannelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateChannelOperation) Wait ¶
func (op *UpdateChannelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Channel, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateInputOperation ¶
type UpdateInputOperation struct {
// contains filtered or unexported fields
}
UpdateInputOperation manages a long-running operation from UpdateInput.
func (*UpdateInputOperation) Done ¶
func (op *UpdateInputOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateInputOperation) Metadata ¶
func (op *UpdateInputOperation) Metadata() (*livestreampb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateInputOperation) Name ¶
func (op *UpdateInputOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateInputOperation) Poll ¶
func (op *UpdateInputOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateInputOperation) Wait ¶
func (op *UpdateInputOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*livestreampb.Input, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.