- 0.115.1 (latest)
- 0.115.0
- 0.114.0
- 0.113.0
- 0.112.2
- 0.111.0
- 0.110.10
- 0.109.0
- 0.108.0
- 0.107.0
- 0.106.0
- 0.105.0
- 0.104.0
- 0.103.0
- 0.102.1
- 0.101.1
- 0.100.2
- 0.99.0
- 0.98.0
- 0.97.0
- 0.96.0
- 0.95.0
- 0.94.1
- 0.93.3
- 0.92.3
- 0.91.1
- 0.90.0
- 0.89.0
- 0.88.0
- 0.87.0
- 0.86.0
- 0.85.0
- 0.84.0
- 0.83.0
- 0.82.0
- 0.81.0
- 0.80.0
- 0.79.0
- 0.78.0
- 0.77.0
- 0.76.0
- 0.75.0
Package essentialcontacts is an auto-generated package for the Essential Contacts API.
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.
CallOptions
type CallOptions struct {
CreateContact []gax.CallOption
UpdateContact []gax.CallOption
ListContacts []gax.CallOption
GetContact []gax.CallOption
DeleteContact []gax.CallOption
ComputeContacts []gax.CallOption
SendTestMessage []gax.CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type Client struct {
// The call options for this service.
CallOptions *CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with Essential Contacts API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Manages contacts for important Google Cloud notifications.
func NewClient
NewClient creates a new essential contacts service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Manages contacts for important Google Cloud notifications.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
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) ComputeContacts
func (c *Client) ComputeContacts(ctx context.Context, req *essentialcontactspb.ComputeContactsRequest, opts ...gax.CallOption) *ContactIterator
ComputeContacts lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
"google.golang.org/api/iterator"
essentialcontactspb "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &essentialcontactspb.ComputeContactsRequest{
// TODO: Fill request struct fields.
}
it := c.ComputeContacts(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) Connection
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) CreateContact
func (c *Client) CreateContact(ctx context.Context, req *essentialcontactspb.CreateContactRequest, opts ...gax.CallOption) (*essentialcontactspb.Contact, error)
CreateContact adds a new contact for a resource.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
essentialcontactspb "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &essentialcontactspb.CreateContactRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateContact(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) DeleteContact
func (c *Client) DeleteContact(ctx context.Context, req *essentialcontactspb.DeleteContactRequest, opts ...gax.CallOption) error
DeleteContact deletes a contact.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
essentialcontactspb "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &essentialcontactspb.DeleteContactRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteContact(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) GetContact
func (c *Client) GetContact(ctx context.Context, req *essentialcontactspb.GetContactRequest, opts ...gax.CallOption) (*essentialcontactspb.Contact, error)
GetContact gets a single contact.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
essentialcontactspb "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &essentialcontactspb.GetContactRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetContact(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ListContacts
func (c *Client) ListContacts(ctx context.Context, req *essentialcontactspb.ListContactsRequest, opts ...gax.CallOption) *ContactIterator
ListContacts lists the contacts that have been set on a resource.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
"google.golang.org/api/iterator"
essentialcontactspb "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &essentialcontactspb.ListContactsRequest{
// TODO: Fill request struct fields.
}
it := c.ListContacts(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) SendTestMessage
func (c *Client) SendTestMessage(ctx context.Context, req *essentialcontactspb.SendTestMessageRequest, opts ...gax.CallOption) error
SendTestMessage allows a contact admin to send a test message to contact to verify that it has been configured correctly.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
essentialcontactspb "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &essentialcontactspb.SendTestMessageRequest{
// TODO: Fill request struct fields.
}
err = c.SendTestMessage(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) UpdateContact
func (c *Client) UpdateContact(ctx context.Context, req *essentialcontactspb.UpdateContactRequest, opts ...gax.CallOption) (*essentialcontactspb.Contact, error)
UpdateContact updates a contact. Note: A contact’s email address cannot be changed.
Example
package main
import (
"context"
essentialcontacts "cloud.google.com/go/essentialcontacts/apiv1"
essentialcontactspb "google.golang.org/genproto/googleapis/cloud/essentialcontacts/v1"
)
func main() {
ctx := context.Background()
c, err := essentialcontacts.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &essentialcontactspb.UpdateContactRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateContact(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
ContactIterator
type ContactIterator 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 []*essentialcontactspb.Contact, nextPageToken string, err error)
// contains filtered or unexported fields
}
ContactIterator manages a stream of *essentialcontactspb.Contact.
func (*ContactIterator) Next
func (it *ContactIterator) Next() (*essentialcontactspb.Contact, 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 (*ContactIterator) PageInfo
func (it *ContactIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.