Cloud Monitoring API v1 - Package cloud.google.com/go/monitoring/dashboard/apiv1 (v0.90.0)

Package dashboard is an auto-generated package for the Cloud Monitoring API.

Manages your Cloud Monitoring data and configurations. Most projects must be associated with a Workspace, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Cloud Monitoring documentation (at https://cloud.google.com/monitoring/docs ).

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.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .

Functions

func DefaultAuthScopes

  func 
  
 DefaultAuthScopes 
 () 
  
 [] 
  string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

DashboardIterator

  type 
  
 DashboardIterator 
  
 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 
  
 [] 
 * 
  dashboardpb 
 
 . 
  Dashboard 
 
 , 
  
 nextPageToken 
  
  string 
 
 , 
  
 err 
  
  error 
 
 ) 
  
 // contains filtered or unexported fields 
 }

DashboardIterator manages a stream of *dashboardpb.Dashboard.

func (*DashboardIterator) Next

  func 
  
 ( 
 it 
  
 * 
  DashboardIterator 
 
 ) 
  
 Next 
 () 
  
 ( 
 * 
  dashboardpb 
 
 . 
  Dashboard 
 
 , 
  
  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 (*DashboardIterator) PageInfo

  func 
  
 ( 
 it 
  
 * 
  DashboardIterator 
 
 ) 
  
 PageInfo 
 () 
  
 * 
  iterator 
 
 . 
  PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

DashboardsCallOptions

  type 
  
 DashboardsCallOptions 
  
 struct 
  
 { 
  
 CreateDashboard 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 ListDashboards 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 GetDashboard 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 DeleteDashboard 
  
 [] 
  gax 
 
 . 
  CallOption 
 
  
 UpdateDashboard 
  
 [] 
  gax 
 
 . 
  CallOption 
 
 }

DashboardsCallOptions contains the retry settings for each method of DashboardsClient.

DashboardsClient

  type 
  
 DashboardsClient 
  
 struct 
  
 { 
  
 // The call options for this service. 
  
 CallOptions 
  
 * 
  DashboardsCallOptions 
 
  
 // contains filtered or unexported fields 
 }

DashboardsClient is a client for interacting with Cloud Monitoring API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.

func NewDashboardsClient

  func 
  
 NewDashboardsClient 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 opts 
  
 ... 
  option 
 
 . 
  ClientOption 
 
 ) 
  
 ( 
 * 
  DashboardsClient 
 
 , 
  
  error 
 
 )

NewDashboardsClient creates a new dashboards service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 dashboard 
  
 "cloud.google.com/go/monitoring/dashboard/apiv1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 dashboard 
 . 
  NewDashboardsClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 defer 
  
 c 
 . 
  Close 
 
 () 
  
 // TODO: Use client. 
  
 _ 
  
 = 
  
 c 
 }

func (*DashboardsClient) Close

  func 
  
 ( 
 c 
  
 * 
  DashboardsClient 
 
 ) 
  
 Close 
 () 
  
  error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*DashboardsClient) Connection

  func 
  
 ( 
 c 
  
 * 
  DashboardsClient 
 
 ) 
  
 Connection 
 () 
  
 * 
  grpc 
 
 . 
  ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*DashboardsClient) CreateDashboard

  func 
  
 ( 
 c 
  
 * 
  DashboardsClient 
 
 ) 
  
 CreateDashboard 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 req 
  
 * 
  dashboardpb 
 
 . 
  CreateDashboardRequest 
 
 , 
  
 opts 
  
 ... 
  gax 
 
 . 
  CallOption 
 
 ) 
  
 ( 
 * 
  dashboardpb 
 
 . 
  Dashboard 
 
 , 
  
  error 
 
 )

CreateDashboard creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API (at https://cloud.google.com/monitoring/dashboards/api-dashboard ). This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management (at https://cloud.google.com/iam ).

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 dashboard 
  
 "cloud.google.com/go/monitoring/dashboard/apiv1" 
  
 dashboardpb 
  
 "google.golang.org/genproto/googleapis/monitoring/dashboard/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 dashboard 
 . 
  NewDashboardsClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 defer 
  
 c 
 . 
  Close 
 
 () 
  
 req 
  
 := 
  
& dashboardpb 
 . 
  CreateDashboardRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 CreateDashboard 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 }

func (*DashboardsClient) DeleteDashboard

  func 
  
 ( 
 c 
  
 * 
  DashboardsClient 
 
 ) 
  
 DeleteDashboard 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 req 
  
 * 
  dashboardpb 
 
 . 
  DeleteDashboardRequest 
 
 , 
  
 opts 
  
 ... 
  gax 
 
 . 
  CallOption 
 
 ) 
  
  error

DeleteDashboard deletes an existing custom dashboard.

This method requires the monitoring.dashboards.delete permission on the specified dashboard. For more information, see Cloud Identity and Access Management (at https://cloud.google.com/iam ).

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 dashboard 
  
 "cloud.google.com/go/monitoring/dashboard/apiv1" 
  
 dashboardpb 
  
 "google.golang.org/genproto/googleapis/monitoring/dashboard/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 dashboard 
 . 
  NewDashboardsClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 defer 
  
 c 
 . 
  Close 
 
 () 
  
 req 
  
 := 
  
& dashboardpb 
 . 
  DeleteDashboardRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 err 
  
 = 
  
 c 
 . 
 DeleteDashboard 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
 }

func (*DashboardsClient) GetDashboard

  func 
  
 ( 
 c 
  
 * 
  DashboardsClient 
 
 ) 
  
 GetDashboard 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 req 
  
 * 
  dashboardpb 
 
 . 
  GetDashboardRequest 
 
 , 
  
 opts 
  
 ... 
  gax 
 
 . 
  CallOption 
 
 ) 
  
 ( 
 * 
  dashboardpb 
 
 . 
  Dashboard 
 
 , 
  
  error 
 
 )

GetDashboard fetches a specific dashboard.

This method requires the monitoring.dashboards.get permission on the specified dashboard. For more information, see Cloud Identity and Access Management (at https://cloud.google.com/iam ).

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 dashboard 
  
 "cloud.google.com/go/monitoring/dashboard/apiv1" 
  
 dashboardpb 
  
 "google.golang.org/genproto/googleapis/monitoring/dashboard/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 dashboard 
 . 
  NewDashboardsClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 defer 
  
 c 
 . 
  Close 
 
 () 
  
 req 
  
 := 
  
& dashboardpb 
 . 
  GetDashboardRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 GetDashboard 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 }

func (*DashboardsClient) ListDashboards

  func 
  
 ( 
 c 
  
 * 
  DashboardsClient 
 
 ) 
  
 ListDashboards 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 req 
  
 * 
  dashboardpb 
 
 . 
  ListDashboardsRequest 
 
 , 
  
 opts 
  
 ... 
  gax 
 
 . 
  CallOption 
 
 ) 
  
 * 
  DashboardIterator

ListDashboards lists the existing dashboards.

This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Cloud Identity and Access Management (at https://cloud.google.com/iam ).

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 dashboard 
  
 "cloud.google.com/go/monitoring/dashboard/apiv1" 
  
 "google.golang.org/api/iterator" 
  
 dashboardpb 
  
 "google.golang.org/genproto/googleapis/monitoring/dashboard/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 dashboard 
 . 
  NewDashboardsClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 defer 
  
 c 
 . 
  Close 
 
 () 
  
 req 
  
 := 
  
& dashboardpb 
 . 
  ListDashboardsRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 it 
  
 := 
  
 c 
 . 
 ListDashboards 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 resp 
 , 
  
 err 
  
 := 
  
 it 
 . 
  Next 
 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
  
 } 
 }

func (*DashboardsClient) UpdateDashboard

  func 
  
 ( 
 c 
  
 * 
  DashboardsClient 
 
 ) 
  
 UpdateDashboard 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 req 
  
 * 
  dashboardpb 
 
 . 
  UpdateDashboardRequest 
 
 , 
  
 opts 
  
 ... 
  gax 
 
 . 
  CallOption 
 
 ) 
  
 ( 
 * 
  dashboardpb 
 
 . 
  Dashboard 
 
 , 
  
  error 
 
 )

UpdateDashboard replaces an existing custom dashboard with a new definition.

This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Cloud Identity and Access Management (at https://cloud.google.com/iam ).

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 dashboard 
  
 "cloud.google.com/go/monitoring/dashboard/apiv1" 
  
 dashboardpb 
  
 "google.golang.org/genproto/googleapis/monitoring/dashboard/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 dashboard 
 . 
  NewDashboardsClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 defer 
  
 c 
 . 
  Close 
 
 () 
  
 req 
  
 := 
  
& dashboardpb 
 . 
  UpdateDashboardRequest 
 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 UpdateDashboard 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 }

Cloud Monitoring API v1 - Package cloud.google.com/go/monitoring/dashboard/apiv1 (v0.90.0) Stay organized with collections Save and categorize content based on your preferences.

Use of Context

Functions

func DefaultAuthScopes

DashboardIterator

func (*DashboardIterator) Next

func (*DashboardIterator) PageInfo

DashboardsCallOptions

DashboardsClient

func NewDashboardsClient

Example

func (*DashboardsClient) Close

func (*DashboardsClient) Connection

func (*DashboardsClient) CreateDashboard

Example

func (*DashboardsClient) DeleteDashboard

Example

func (*DashboardsClient) GetDashboard

Example

func (*DashboardsClient) ListDashboards

Example

func (*DashboardsClient) UpdateDashboard

Example

Cloud Monitoring API v1 - Package cloud.google.com/go/monitoring/dashboard/apiv1 (v0.90.0)