essentialcontacts

package
v0.195.0 Latest Latest
Warning

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

 Go to latest Published: Aug 28, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

Package essentialcontacts provides access to the Essential Contacts API.

For product documentation, see: https://cloud.google.com/essentialcontacts/docs/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/essentialcontacts/v1"
...
ctx := context.Background()
essentialcontactsService, err := essentialcontacts.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

essentialcontactsService, err := essentialcontacts.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
essentialcontactsService, err := essentialcontacts.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type FoldersContactsComputeCall 

type FoldersContactsComputeCall struct {
	// contains filtered or unexported fields
}

func (*FoldersContactsComputeCall) Context 

func (c *FoldersContactsComputeCall) Context(ctx context.Context) *FoldersContactsComputeCall

Context sets the context to be used in this call's Do method.

func (*FoldersContactsComputeCall) Do 

func (c *FoldersContactsComputeCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1ComputeContactsResponse, error)

Do executes the "essentialcontacts.folders.contacts.compute" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ComputeContactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersContactsComputeCall) Fields 

func (c *FoldersContactsComputeCall) Fields(s ...googleapi.Field) *FoldersContactsComputeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersContactsComputeCall) Header 

func (c *FoldersContactsComputeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersContactsComputeCall) IfNoneMatch 

func (c *FoldersContactsComputeCall) IfNoneMatch(entityTag string) *FoldersContactsComputeCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*FoldersContactsComputeCall) NotificationCategories 

func (c *FoldersContactsComputeCall) NotificationCategories(notificationCategories ...string) *FoldersContactsComputeCall

NotificationCategories sets the optional parameter "notificationCategories": The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

Possible values: 

"NOTIFICATION_CATEGORY_UNSPECIFIED" - Notification category is

unrecognized or unspecified. 

"ALL" - All notifications related to the resource, including notifications

pertaining to categories added in the future. 

"SUSPENSION" - Notifications related to imminent account suspension.
"SECURITY" - Notifications related to security/privacy incidents,

notifications, and vulnerabilities. 

"TECHNICAL" - Notifications related to technical events and issues such as

outages, errors, or bugs. 

"BILLING" - Notifications related to billing and payments notifications,

price updates, errors, or credits. 

"LEGAL" - Notifications related to enforcement actions, regulatory

compliance, or government notices. 

"PRODUCT_UPDATES" - Notifications related to new versions, product terms

updates, or deprecations. 

"TECHNICAL_INCIDENTS" - Child category of TECHNICAL. If assigned,

technical incident notifications will go to these contacts instead of TECHNICAL.

func (*FoldersContactsComputeCall) PageSize 

func (c *FoldersContactsComputeCall) PageSize(pageSize int64) *FoldersContactsComputeCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.

func (*FoldersContactsComputeCall) PageToken 

func (c *FoldersContactsComputeCall) PageToken(pageToken string) *FoldersContactsComputeCall

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.

func (*FoldersContactsComputeCall) Pages 

func (c *FoldersContactsComputeCall) Pages(ctx context.Context, f func(*GoogleCloudEssentialcontactsV1ComputeContactsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type FoldersContactsCreateCall 

type FoldersContactsCreateCall struct {
	// contains filtered or unexported fields
}

func (*FoldersContactsCreateCall) Context 

func (c *FoldersContactsCreateCall) Context(ctx context.Context) *FoldersContactsCreateCall

Context sets the context to be used in this call's Do method.

func (*FoldersContactsCreateCall) Do 

func (c *FoldersContactsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.folders.contacts.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersContactsCreateCall) Fields 

func (c *FoldersContactsCreateCall) Fields(s ...googleapi.Field) *FoldersContactsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersContactsCreateCall) Header 

func (c *FoldersContactsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersContactsDeleteCall 

type FoldersContactsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*FoldersContactsDeleteCall) Context 

func (c *FoldersContactsDeleteCall) Context(ctx context.Context) *FoldersContactsDeleteCall

Context sets the context to be used in this call's Do method.

func (*FoldersContactsDeleteCall) Do 

func (c *FoldersContactsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)

Do executes the "essentialcontacts.folders.contacts.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersContactsDeleteCall) Fields 

func (c *FoldersContactsDeleteCall) Fields(s ...googleapi.Field) *FoldersContactsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersContactsDeleteCall) Header 

func (c *FoldersContactsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersContactsGetCall 

type FoldersContactsGetCall struct {
	// contains filtered or unexported fields
}

func (*FoldersContactsGetCall) Context 

func (c *FoldersContactsGetCall) Context(ctx context.Context) *FoldersContactsGetCall

Context sets the context to be used in this call's Do method.

func (*FoldersContactsGetCall) Do 

func (c *FoldersContactsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.folders.contacts.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersContactsGetCall) Fields 

func (c *FoldersContactsGetCall) Fields(s ...googleapi.Field) *FoldersContactsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersContactsGetCall) Header 

func (c *FoldersContactsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersContactsGetCall) IfNoneMatch 

func (c *FoldersContactsGetCall) IfNoneMatch(entityTag string) *FoldersContactsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type FoldersContactsListCall 

type FoldersContactsListCall struct {
	// contains filtered or unexported fields
}

func (*FoldersContactsListCall) Context 

func (c *FoldersContactsListCall) Context(ctx context.Context) *FoldersContactsListCall

Context sets the context to be used in this call's Do method.

func (*FoldersContactsListCall) Do 

func (c *FoldersContactsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1ListContactsResponse, error)

Do executes the "essentialcontacts.folders.contacts.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ListContactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersContactsListCall) Fields 

func (c *FoldersContactsListCall) Fields(s ...googleapi.Field) *FoldersContactsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersContactsListCall) Header 

func (c *FoldersContactsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersContactsListCall) IfNoneMatch 

func (c *FoldersContactsListCall) IfNoneMatch(entityTag string) *FoldersContactsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*FoldersContactsListCall) PageSize 

func (c *FoldersContactsListCall) PageSize(pageSize int64) *FoldersContactsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.

func (*FoldersContactsListCall) PageToken 

func (c *FoldersContactsListCall) PageToken(pageToken string) *FoldersContactsListCall

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.

func (*FoldersContactsListCall) Pages 

func (c *FoldersContactsListCall) Pages(ctx context.Context, f func(*GoogleCloudEssentialcontactsV1ListContactsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type FoldersContactsPatchCall 

type FoldersContactsPatchCall struct {
	// contains filtered or unexported fields
}

func (*FoldersContactsPatchCall) Context 

func (c *FoldersContactsPatchCall) Context(ctx context.Context) *FoldersContactsPatchCall

Context sets the context to be used in this call's Do method.

func (*FoldersContactsPatchCall) Do 

func (c *FoldersContactsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.folders.contacts.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersContactsPatchCall) Fields 

func (c *FoldersContactsPatchCall) Fields(s ...googleapi.Field) *FoldersContactsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersContactsPatchCall) Header 

func (c *FoldersContactsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersContactsPatchCall) UpdateMask 

func (c *FoldersContactsPatchCall) UpdateMask(updateMask string) *FoldersContactsPatchCall

UpdateMask sets the optional parameter "updateMask": The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type FoldersContactsSendTestMessageCall 

type FoldersContactsSendTestMessageCall struct {
	// contains filtered or unexported fields
}

func (*FoldersContactsSendTestMessageCall) Context 

func (c *FoldersContactsSendTestMessageCall) Context(ctx context.Context) *FoldersContactsSendTestMessageCall

Context sets the context to be used in this call's Do method.

func (*FoldersContactsSendTestMessageCall) Do 

func (c *FoldersContactsSendTestMessageCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)

Do executes the "essentialcontacts.folders.contacts.sendTestMessage" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersContactsSendTestMessageCall) Fields 

func (c *FoldersContactsSendTestMessageCall) Fields(s ...googleapi.Field) *FoldersContactsSendTestMessageCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersContactsSendTestMessageCall) Header 

func (c *FoldersContactsSendTestMessageCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersContactsService 

type FoldersContactsService struct {
	// contains filtered or unexported fields
}

func NewFoldersContactsService 

func NewFoldersContactsService(s *Service) *FoldersContactsService

func (*FoldersContactsService) Compute 

func (r *FoldersContactsService) Compute(parent string) *FoldersContactsComputeCall

Compute: Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

  • parent: The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*FoldersContactsService) Create 

func (r *FoldersContactsService) Create(parent string, googlecloudessentialcontactsv1contact *GoogleCloudEssentialcontactsV1Contact) *FoldersContactsCreateCall

Create: Adds a new contact for a resource.

  • parent: The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*FoldersContactsService) Delete 

func (r *FoldersContactsService) Delete(name string) *FoldersContactsDeleteCall

Delete: Deletes a contact.

  • name: The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}.

func (*FoldersContactsService) Get 

func (r *FoldersContactsService) Get(name string) *FoldersContactsGetCall

Get: Gets a single contact.

  • name: The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}.

func (*FoldersContactsService) List 

func (r *FoldersContactsService) List(parent string) *FoldersContactsListCall

List: Lists the contacts that have been set on a resource.

  • parent: The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*FoldersContactsService) Patch 

func (r *FoldersContactsService) Patch(nameid string, googlecloudessentialcontactsv1contact *GoogleCloudEssentialcontactsV1Contact) *FoldersContactsPatchCall

Patch: Updates a contact. Note: A contact's email address cannot be changed.

  • name: Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}.

func (*FoldersContactsService) SendTestMessage 

func (r *FoldersContactsService) SendTestMessage(resource string, googlecloudessentialcontactsv1sendtestmessagerequest *GoogleCloudEssentialcontactsV1SendTestMessageRequest) *FoldersContactsSendTestMessageCall

SendTestMessage: Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

  • resource: The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

type FoldersService 

type FoldersService struct {
	Contacts *FoldersContactsService
	// contains filtered or unexported fields
}

func NewFoldersService 

func NewFoldersService(s *Service) *FoldersService

type GoogleCloudEssentialcontactsV1ComputeContactsResponse 

type GoogleCloudEssentialcontactsV1ComputeContactsResponse struct {
	// Contacts: All contacts for the resource that are subscribed to the specified
	// notification categories, including contacts inherited from any parent
	// resources.
	Contacts []*GoogleCloudEssentialcontactsV1Contact `json:"contacts,omitempty"`
	// NextPageToken: If there are more results than those appearing in this
	// response, then `next_page_token` is included. To get the next set of
	// results, call this method again using the value of `next_page_token` as
	// `page_token` and the rest of the parameters the same as the original
	// request.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Contacts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Contacts") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudEssentialcontactsV1ComputeContactsResponse: Response message for the ComputeContacts method.

func (GoogleCloudEssentialcontactsV1ComputeContactsResponse) MarshalJSON 

func (s GoogleCloudEssentialcontactsV1ComputeContactsResponse) MarshalJSON() ([]byte, error)

type GoogleCloudEssentialcontactsV1Contact 

type GoogleCloudEssentialcontactsV1Contact struct {
	// Email: Required. The email address to send notifications to. The email
	// address does not need to be a Google Account.
	Email string `json:"email,omitempty"`
	// LanguageTag: Required. The preferred language for notifications, as a ISO
	// 639-1 language code. See Supported languages
	// (https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages)
	// for a list of supported languages.
	LanguageTag string `json:"languageTag,omitempty"`
	// Name: Output only. The identifier for the contact. Format:
	// {resource_type}/{resource_id}/contacts/{contact_id}
	Name string `json:"name,omitempty"`
	// NotificationCategorySubscriptions: Required. The categories of notifications
	// that the contact will receive communications for.
	//
	// Possible values:
	//   "NOTIFICATION_CATEGORY_UNSPECIFIED" - Notification category is
	// unrecognized or unspecified.
	//   "ALL" - All notifications related to the resource, including notifications
	// pertaining to categories added in the future.
	//   "SUSPENSION" - Notifications related to imminent account suspension.
	//   "SECURITY" - Notifications related to security/privacy incidents,
	// notifications, and vulnerabilities.
	//   "TECHNICAL" - Notifications related to technical events and issues such as
	// outages, errors, or bugs.
	//   "BILLING" - Notifications related to billing and payments notifications,
	// price updates, errors, or credits.
	//   "LEGAL" - Notifications related to enforcement actions, regulatory
	// compliance, or government notices.
	//   "PRODUCT_UPDATES" - Notifications related to new versions, product terms
	// updates, or deprecations.
	//   "TECHNICAL_INCIDENTS" - Child category of TECHNICAL. If assigned,
	// technical incident notifications will go to these contacts instead of
	// TECHNICAL.
	NotificationCategorySubscriptions []string `json:"notificationCategorySubscriptions,omitempty"`
	// ValidateTime: The last time the validation_state was updated, either
	// manually or automatically. A contact is considered stale if its validation
	// state was updated more than 1 year ago.
	ValidateTime string `json:"validateTime,omitempty"`
	// ValidationState: Output only. The validity of the contact. A contact is
	// considered valid if it is the correct recipient for notifications for a
	// particular resource.
	//
	// Possible values:
	//   "VALIDATION_STATE_UNSPECIFIED" - The validation state is unknown or
	// unspecified.
	//   "VALID" - The contact is marked as valid. This is usually done manually by
	// the contact admin. All new contacts begin in the valid state.
	//   "INVALID" - The contact is considered invalid. This may become the state
	// if the contact's email is found to be unreachable.
	ValidationState string `json:"validationState,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Email") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Email") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudEssentialcontactsV1Contact: A contact that will receive notifications from Google Cloud.

func (GoogleCloudEssentialcontactsV1Contact) MarshalJSON 

func (s GoogleCloudEssentialcontactsV1Contact) MarshalJSON() ([]byte, error)

type GoogleCloudEssentialcontactsV1ListContactsResponse 

type GoogleCloudEssentialcontactsV1ListContactsResponse struct {
	// Contacts: The contacts for the specified resource.
	Contacts []*GoogleCloudEssentialcontactsV1Contact `json:"contacts,omitempty"`
	// NextPageToken: If there are more results than those appearing in this
	// response, then `next_page_token` is included. To get the next set of
	// results, call this method again using the value of `next_page_token` as
	// `page_token` and the rest of the parameters the same as the original
	// request.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Contacts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Contacts") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudEssentialcontactsV1ListContactsResponse: Response message for the ListContacts method.

func (GoogleCloudEssentialcontactsV1ListContactsResponse) MarshalJSON 

func (s GoogleCloudEssentialcontactsV1ListContactsResponse) MarshalJSON() ([]byte, error)

type GoogleCloudEssentialcontactsV1SendTestMessageRequest 

type GoogleCloudEssentialcontactsV1SendTestMessageRequest struct {
	// Contacts: Required. The list of names of the contacts to send a test message
	// to. Format: organizations/{organization_id}/contacts/{contact_id},
	// folders/{folder_id}/contacts/{contact_id} or
	// projects/{project_id}/contacts/{contact_id}
	Contacts []string `json:"contacts,omitempty"`
	// NotificationCategory: Required. The notification category to send the test
	// message for. All contacts must be subscribed to this category.
	//
	// Possible values:
	//   "NOTIFICATION_CATEGORY_UNSPECIFIED" - Notification category is
	// unrecognized or unspecified.
	//   "ALL" - All notifications related to the resource, including notifications
	// pertaining to categories added in the future.
	//   "SUSPENSION" - Notifications related to imminent account suspension.
	//   "SECURITY" - Notifications related to security/privacy incidents,
	// notifications, and vulnerabilities.
	//   "TECHNICAL" - Notifications related to technical events and issues such as
	// outages, errors, or bugs.
	//   "BILLING" - Notifications related to billing and payments notifications,
	// price updates, errors, or credits.
	//   "LEGAL" - Notifications related to enforcement actions, regulatory
	// compliance, or government notices.
	//   "PRODUCT_UPDATES" - Notifications related to new versions, product terms
	// updates, or deprecations.
	//   "TECHNICAL_INCIDENTS" - Child category of TECHNICAL. If assigned,
	// technical incident notifications will go to these contacts instead of
	// TECHNICAL.
	NotificationCategory string `json:"notificationCategory,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Contacts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Contacts") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudEssentialcontactsV1SendTestMessageRequest: Request message for the SendTestMessage method.

func (GoogleCloudEssentialcontactsV1SendTestMessageRequest) MarshalJSON 

func (s GoogleCloudEssentialcontactsV1SendTestMessageRequest) MarshalJSON() ([]byte, error)

type GoogleProtobufEmpty 

type GoogleProtobufEmpty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

GoogleProtobufEmpty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type OrganizationsContactsComputeCall 

type OrganizationsContactsComputeCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsContactsComputeCall) Context 

func (c *OrganizationsContactsComputeCall) Context(ctx context.Context) *OrganizationsContactsComputeCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsContactsComputeCall) Do 

func (c *OrganizationsContactsComputeCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1ComputeContactsResponse, error)

Do executes the "essentialcontacts.organizations.contacts.compute" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ComputeContactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsContactsComputeCall) Fields 

func (c *OrganizationsContactsComputeCall) Fields(s ...googleapi.Field) *OrganizationsContactsComputeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsContactsComputeCall) Header 

func (c *OrganizationsContactsComputeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsContactsComputeCall) IfNoneMatch 

func (c *OrganizationsContactsComputeCall) IfNoneMatch(entityTag string) *OrganizationsContactsComputeCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsContactsComputeCall) NotificationCategories 

func (c *OrganizationsContactsComputeCall) NotificationCategories(notificationCategories ...string) *OrganizationsContactsComputeCall

NotificationCategories sets the optional parameter "notificationCategories": The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

Possible values: 

"NOTIFICATION_CATEGORY_UNSPECIFIED" - Notification category is

unrecognized or unspecified. 

"ALL" - All notifications related to the resource, including notifications

pertaining to categories added in the future. 

"SUSPENSION" - Notifications related to imminent account suspension.
"SECURITY" - Notifications related to security/privacy incidents,

notifications, and vulnerabilities. 

"TECHNICAL" - Notifications related to technical events and issues such as

outages, errors, or bugs. 

"BILLING" - Notifications related to billing and payments notifications,

price updates, errors, or credits. 

"LEGAL" - Notifications related to enforcement actions, regulatory

compliance, or government notices. 

"PRODUCT_UPDATES" - Notifications related to new versions, product terms

updates, or deprecations. 

"TECHNICAL_INCIDENTS" - Child category of TECHNICAL. If assigned,

technical incident notifications will go to these contacts instead of TECHNICAL.

func (*OrganizationsContactsComputeCall) PageSize 

func (c *OrganizationsContactsComputeCall) PageSize(pageSize int64) *OrganizationsContactsComputeCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.

func (*OrganizationsContactsComputeCall) PageToken 

func (c *OrganizationsContactsComputeCall) PageToken(pageToken string) *OrganizationsContactsComputeCall

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.

func (*OrganizationsContactsComputeCall) Pages 

func (c *OrganizationsContactsComputeCall) Pages(ctx context.Context, f func(*GoogleCloudEssentialcontactsV1ComputeContactsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OrganizationsContactsCreateCall 

type OrganizationsContactsCreateCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsContactsCreateCall) Context 

func (c *OrganizationsContactsCreateCall) Context(ctx context.Context) *OrganizationsContactsCreateCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsContactsCreateCall) Do 

func (c *OrganizationsContactsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.organizations.contacts.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsContactsCreateCall) Fields 

func (c *OrganizationsContactsCreateCall) Fields(s ...googleapi.Field) *OrganizationsContactsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsContactsCreateCall) Header 

func (c *OrganizationsContactsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsContactsDeleteCall 

type OrganizationsContactsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsContactsDeleteCall) Context 

func (c *OrganizationsContactsDeleteCall) Context(ctx context.Context) *OrganizationsContactsDeleteCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsContactsDeleteCall) Do 

func (c *OrganizationsContactsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)

Do executes the "essentialcontacts.organizations.contacts.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsContactsDeleteCall) Fields 

func (c *OrganizationsContactsDeleteCall) Fields(s ...googleapi.Field) *OrganizationsContactsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsContactsDeleteCall) Header 

func (c *OrganizationsContactsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsContactsGetCall 

type OrganizationsContactsGetCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsContactsGetCall) Context 

func (c *OrganizationsContactsGetCall) Context(ctx context.Context) *OrganizationsContactsGetCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsContactsGetCall) Do 

func (c *OrganizationsContactsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.organizations.contacts.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsContactsGetCall) Fields 

func (c *OrganizationsContactsGetCall) Fields(s ...googleapi.Field) *OrganizationsContactsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsContactsGetCall) Header 

func (c *OrganizationsContactsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsContactsGetCall) IfNoneMatch 

func (c *OrganizationsContactsGetCall) IfNoneMatch(entityTag string) *OrganizationsContactsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OrganizationsContactsListCall 

type OrganizationsContactsListCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsContactsListCall) Context 

func (c *OrganizationsContactsListCall) Context(ctx context.Context) *OrganizationsContactsListCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsContactsListCall) Do 

func (c *OrganizationsContactsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1ListContactsResponse, error)

Do executes the "essentialcontacts.organizations.contacts.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ListContactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsContactsListCall) Fields 

func (c *OrganizationsContactsListCall) Fields(s ...googleapi.Field) *OrganizationsContactsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsContactsListCall) Header 

func (c *OrganizationsContactsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsContactsListCall) IfNoneMatch 

func (c *OrganizationsContactsListCall) IfNoneMatch(entityTag string) *OrganizationsContactsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsContactsListCall) PageSize 

func (c *OrganizationsContactsListCall) PageSize(pageSize int64) *OrganizationsContactsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.

func (*OrganizationsContactsListCall) PageToken 

func (c *OrganizationsContactsListCall) PageToken(pageToken string) *OrganizationsContactsListCall

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.

func (*OrganizationsContactsListCall) Pages 

func (c *OrganizationsContactsListCall) Pages(ctx context.Context, f func(*GoogleCloudEssentialcontactsV1ListContactsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OrganizationsContactsPatchCall 

type OrganizationsContactsPatchCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsContactsPatchCall) Context 

func (c *OrganizationsContactsPatchCall) Context(ctx context.Context) *OrganizationsContactsPatchCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsContactsPatchCall) Do 

func (c *OrganizationsContactsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.organizations.contacts.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsContactsPatchCall) Fields 

func (c *OrganizationsContactsPatchCall) Fields(s ...googleapi.Field) *OrganizationsContactsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsContactsPatchCall) Header 

func (c *OrganizationsContactsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsContactsPatchCall) UpdateMask 

func (c *OrganizationsContactsPatchCall) UpdateMask(updateMask string) *OrganizationsContactsPatchCall

UpdateMask sets the optional parameter "updateMask": The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type OrganizationsContactsSendTestMessageCall 

type OrganizationsContactsSendTestMessageCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsContactsSendTestMessageCall) Context 

func (c *OrganizationsContactsSendTestMessageCall) Context(ctx context.Context) *OrganizationsContactsSendTestMessageCall

Context sets the context to be used in this call's Do method.

func (*OrganizationsContactsSendTestMessageCall) Do 

func (c *OrganizationsContactsSendTestMessageCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)

Do executes the "essentialcontacts.organizations.contacts.sendTestMessage" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsContactsSendTestMessageCall) Fields 

func (c *OrganizationsContactsSendTestMessageCall) Fields(s ...googleapi.Field) *OrganizationsContactsSendTestMessageCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsContactsSendTestMessageCall) Header 

func (c *OrganizationsContactsSendTestMessageCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsContactsService 

type OrganizationsContactsService struct {
	// contains filtered or unexported fields
}

func NewOrganizationsContactsService 

func NewOrganizationsContactsService(s *Service) *OrganizationsContactsService

func (*OrganizationsContactsService) Compute 

func (r *OrganizationsContactsService) Compute(parent string) *OrganizationsContactsComputeCall

Compute: Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

  • parent: The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*OrganizationsContactsService) Create 

func (r *OrganizationsContactsService) Create(parent string, googlecloudessentialcontactsv1contact *GoogleCloudEssentialcontactsV1Contact) *OrganizationsContactsCreateCall

Create: Adds a new contact for a resource.

  • parent: The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*OrganizationsContactsService) Delete 

func (r *OrganizationsContactsService) Delete(name string) *OrganizationsContactsDeleteCall

Delete: Deletes a contact.

  • name: The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}.

func (*OrganizationsContactsService) Get 

func (r *OrganizationsContactsService) Get(name string) *OrganizationsContactsGetCall

Get: Gets a single contact.

  • name: The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}.

func (*OrganizationsContactsService) List 

func (r *OrganizationsContactsService) List(parent string) *OrganizationsContactsListCall

List: Lists the contacts that have been set on a resource.

  • parent: The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*OrganizationsContactsService) Patch 

func (r *OrganizationsContactsService) Patch(nameid string, googlecloudessentialcontactsv1contact *GoogleCloudEssentialcontactsV1Contact) *OrganizationsContactsPatchCall

Patch: Updates a contact. Note: A contact's email address cannot be changed.

  • name: Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}.

func (*OrganizationsContactsService) SendTestMessage 

func (r *OrganizationsContactsService) SendTestMessage(resource string, googlecloudessentialcontactsv1sendtestmessagerequest *GoogleCloudEssentialcontactsV1SendTestMessageRequest) *OrganizationsContactsSendTestMessageCall

SendTestMessage: Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

  • resource: The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

type OrganizationsService 

type OrganizationsService struct {
	Contacts *OrganizationsContactsService
	// contains filtered or unexported fields
}

func NewOrganizationsService 

func NewOrganizationsService(s *Service) *OrganizationsService

type ProjectsContactsComputeCall 

type ProjectsContactsComputeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsContactsComputeCall) Context 

func (c *ProjectsContactsComputeCall) Context(ctx context.Context) *ProjectsContactsComputeCall

Context sets the context to be used in this call's Do method.

func (*ProjectsContactsComputeCall) Do 

func (c *ProjectsContactsComputeCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1ComputeContactsResponse, error)

Do executes the "essentialcontacts.projects.contacts.compute" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ComputeContactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsContactsComputeCall) Fields 

func (c *ProjectsContactsComputeCall) Fields(s ...googleapi.Field) *ProjectsContactsComputeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsContactsComputeCall) Header 

func (c *ProjectsContactsComputeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsContactsComputeCall) IfNoneMatch 

func (c *ProjectsContactsComputeCall) IfNoneMatch(entityTag string) *ProjectsContactsComputeCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsContactsComputeCall) NotificationCategories 

func (c *ProjectsContactsComputeCall) NotificationCategories(notificationCategories ...string) *ProjectsContactsComputeCall

NotificationCategories sets the optional parameter "notificationCategories": The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

Possible values: 

"NOTIFICATION_CATEGORY_UNSPECIFIED" - Notification category is

unrecognized or unspecified. 

"ALL" - All notifications related to the resource, including notifications

pertaining to categories added in the future. 

"SUSPENSION" - Notifications related to imminent account suspension.
"SECURITY" - Notifications related to security/privacy incidents,

notifications, and vulnerabilities. 

"TECHNICAL" - Notifications related to technical events and issues such as

outages, errors, or bugs. 

"BILLING" - Notifications related to billing and payments notifications,

price updates, errors, or credits. 

"LEGAL" - Notifications related to enforcement actions, regulatory

compliance, or government notices. 

"PRODUCT_UPDATES" - Notifications related to new versions, product terms

updates, or deprecations. 

"TECHNICAL_INCIDENTS" - Child category of TECHNICAL. If assigned,

technical incident notifications will go to these contacts instead of TECHNICAL.

func (*ProjectsContactsComputeCall) PageSize 

func (c *ProjectsContactsComputeCall) PageSize(pageSize int64) *ProjectsContactsComputeCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.

func (*ProjectsContactsComputeCall) PageToken 

func (c *ProjectsContactsComputeCall) PageToken(pageToken string) *ProjectsContactsComputeCall

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.

func (*ProjectsContactsComputeCall) Pages 

func (c *ProjectsContactsComputeCall) Pages(ctx context.Context, f func(*GoogleCloudEssentialcontactsV1ComputeContactsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsContactsCreateCall 

type ProjectsContactsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsContactsCreateCall) Context 

func (c *ProjectsContactsCreateCall) Context(ctx context.Context) *ProjectsContactsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsContactsCreateCall) Do 

func (c *ProjectsContactsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.projects.contacts.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsContactsCreateCall) Fields 

func (c *ProjectsContactsCreateCall) Fields(s ...googleapi.Field) *ProjectsContactsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsContactsCreateCall) Header 

func (c *ProjectsContactsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsContactsDeleteCall 

type ProjectsContactsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsContactsDeleteCall) Context 

func (c *ProjectsContactsDeleteCall) Context(ctx context.Context) *ProjectsContactsDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsContactsDeleteCall) Do 

func (c *ProjectsContactsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)

Do executes the "essentialcontacts.projects.contacts.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsContactsDeleteCall) Fields 

func (c *ProjectsContactsDeleteCall) Fields(s ...googleapi.Field) *ProjectsContactsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsContactsDeleteCall) Header 

func (c *ProjectsContactsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsContactsGetCall 

type ProjectsContactsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsContactsGetCall) Context 

func (c *ProjectsContactsGetCall) Context(ctx context.Context) *ProjectsContactsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsContactsGetCall) Do 

func (c *ProjectsContactsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.projects.contacts.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsContactsGetCall) Fields 

func (c *ProjectsContactsGetCall) Fields(s ...googleapi.Field) *ProjectsContactsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsContactsGetCall) Header 

func (c *ProjectsContactsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsContactsGetCall) IfNoneMatch 

func (c *ProjectsContactsGetCall) IfNoneMatch(entityTag string) *ProjectsContactsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsContactsListCall 

type ProjectsContactsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsContactsListCall) Context 

func (c *ProjectsContactsListCall) Context(ctx context.Context) *ProjectsContactsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsContactsListCall) Do 

func (c *ProjectsContactsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1ListContactsResponse, error)

Do executes the "essentialcontacts.projects.contacts.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ListContactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsContactsListCall) Fields 

func (c *ProjectsContactsListCall) Fields(s ...googleapi.Field) *ProjectsContactsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsContactsListCall) Header 

func (c *ProjectsContactsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsContactsListCall) IfNoneMatch 

func (c *ProjectsContactsListCall) IfNoneMatch(entityTag string) *ProjectsContactsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsContactsListCall) PageSize 

func (c *ProjectsContactsListCall) PageSize(pageSize int64) *ProjectsContactsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available. If not specified, the default page_size is 100.

func (*ProjectsContactsListCall) PageToken 

func (c *ProjectsContactsListCall) PageToken(pageToken string) *ProjectsContactsListCall

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.

func (*ProjectsContactsListCall) Pages 

func (c *ProjectsContactsListCall) Pages(ctx context.Context, f func(*GoogleCloudEssentialcontactsV1ListContactsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsContactsPatchCall 

type ProjectsContactsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsContactsPatchCall) Context 

func (c *ProjectsContactsPatchCall) Context(ctx context.Context) *ProjectsContactsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsContactsPatchCall) Do 

func (c *ProjectsContactsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleCloudEssentialcontactsV1Contact, error)

Do executes the "essentialcontacts.projects.contacts.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1Contact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsContactsPatchCall) Fields 

func (c *ProjectsContactsPatchCall) Fields(s ...googleapi.Field) *ProjectsContactsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsContactsPatchCall) Header 

func (c *ProjectsContactsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsContactsPatchCall) UpdateMask 

func (c *ProjectsContactsPatchCall) UpdateMask(updateMask string) *ProjectsContactsPatchCall

UpdateMask sets the optional parameter "updateMask": The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsContactsSendTestMessageCall 

type ProjectsContactsSendTestMessageCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsContactsSendTestMessageCall) Context 

func (c *ProjectsContactsSendTestMessageCall) Context(ctx context.Context) *ProjectsContactsSendTestMessageCall

Context sets the context to be used in this call's Do method.

func (*ProjectsContactsSendTestMessageCall) Do 

func (c *ProjectsContactsSendTestMessageCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)

Do executes the "essentialcontacts.projects.contacts.sendTestMessage" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsContactsSendTestMessageCall) Fields 

func (c *ProjectsContactsSendTestMessageCall) Fields(s ...googleapi.Field) *ProjectsContactsSendTestMessageCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsContactsSendTestMessageCall) Header 

func (c *ProjectsContactsSendTestMessageCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsContactsService 

type ProjectsContactsService struct {
	// contains filtered or unexported fields
}

func NewProjectsContactsService 

func NewProjectsContactsService(s *Service) *ProjectsContactsService

func (*ProjectsContactsService) Compute 

func (r *ProjectsContactsService) Compute(parent string) *ProjectsContactsComputeCall

Compute: Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

  • parent: The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*ProjectsContactsService) Create 

func (r *ProjectsContactsService) Create(parent string, googlecloudessentialcontactsv1contact *GoogleCloudEssentialcontactsV1Contact) *ProjectsContactsCreateCall

Create: Adds a new contact for a resource.

  • parent: The resource to save this contact for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*ProjectsContactsService) Delete 

func (r *ProjectsContactsService) Delete(name string) *ProjectsContactsDeleteCall

Delete: Deletes a contact.

  • name: The name of the contact to delete. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}.

func (*ProjectsContactsService) Get 

func (r *ProjectsContactsService) Get(name string) *ProjectsContactsGetCall

Get: Gets a single contact.

  • name: The name of the contact to retrieve. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{project_id}/contacts/{contact_id}.

func (*ProjectsContactsService) List 

func (r *ProjectsContactsService) List(parent string) *ProjectsContactsListCall

List: Lists the contacts that have been set on a resource.

  • parent: The parent resource name. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

func (*ProjectsContactsService) Patch 

func (r *ProjectsContactsService) Patch(nameid string, googlecloudessentialcontactsv1contact *GoogleCloudEssentialcontactsV1Contact) *ProjectsContactsPatchCall

Patch: Updates a contact. Note: A contact's email address cannot be changed.

  • name: Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id}.

func (*ProjectsContactsService) SendTestMessage 

func (r *ProjectsContactsService) SendTestMessage(resource string, googlecloudessentialcontactsv1sendtestmessagerequest *GoogleCloudEssentialcontactsV1SendTestMessageRequest) *ProjectsContactsSendTestMessageCall

SendTestMessage: Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

  • resource: The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}.

type ProjectsService 

type ProjectsService struct {
	Contacts *ProjectsContactsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Folders *FoldersService

	Organizations *OrganizationsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.