essentialcontacts

package
v0.48.1-0...-67a0a95 Latest Latest
Warning

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

Go to latest
Published: Jun 22, 2021 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package essentialcontacts provides access to the Essential Contacts API.

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

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 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 option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud Platform data
	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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersContactsComputeCall) Do

Do executes the "essentialcontacts.folders.contacts.compute" call. Exactly one of *GoogleCloudEssentialcontactsV1ComputeContactsResponse or error will be non-nil. 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

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

func (*FoldersContactsComputeCall) Header

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

func (*FoldersContactsComputeCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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

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

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

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersContactsCreateCall) Do

Do executes the "essentialcontacts.folders.contacts.create" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*FoldersContactsCreateCall) Header

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

type FoldersContactsDeleteCall

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

func (*FoldersContactsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersContactsDeleteCall) Do

Do executes the "essentialcontacts.folders.contacts.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. 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

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

func (*FoldersContactsDeleteCall) Header

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

type FoldersContactsGetCall

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

func (*FoldersContactsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersContactsGetCall) Do

Do executes the "essentialcontacts.folders.contacts.get" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*FoldersContactsGetCall) Header

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

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

func (*FoldersContactsGetCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type FoldersContactsListCall

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

func (*FoldersContactsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersContactsListCall) Do

Do executes the "essentialcontacts.folders.contacts.list" call. Exactly one of *GoogleCloudEssentialcontactsV1ListContactsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ListContactsResponse.ServerResponse.Hea der 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

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

func (*FoldersContactsListCall) Header

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

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

func (*FoldersContactsListCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersContactsPatchCall) Do

Do executes the "essentialcontacts.folders.contacts.patch" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*FoldersContactsPatchCall) Header

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

Header returns an http.Header that can be modified by the caller to add HTTP 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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersContactsSendTestMessageCall) Do

Do executes the "essentialcontacts.folders.contacts.sendTestMessage" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. 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

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

func (*FoldersContactsSendTestMessageCall) Header

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

type FoldersContactsService

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

func NewFoldersContactsService

func NewFoldersContactsService(s *Service) *FoldersContactsService

func (*FoldersContactsService) Compute

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

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

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

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: 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudEssentialcontactsV1ComputeContactsResponse: Response message for the ComputeContacts method.

func (*GoogleCloudEssentialcontactsV1ComputeContactsResponse) MarshalJSON

type GoogleCloudEssentialcontactsV1Contact

type GoogleCloudEssentialcontactsV1Contact struct {
	// Email: Required. The email address to send notifications to. This
	// does not need to be a Google account.
	Email string `json:"email,omitempty"`

	// LanguageTag: 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: The identifier for the contact. Format:
	// {resource_type}/{resource_id}/contacts/{contact_id}
	Name string `json:"name,omitempty"`

	// NotificationCategorySubscriptions: 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: 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudEssentialcontactsV1ListContactsResponse: Response message for the ListContacts method.

func (*GoogleCloudEssentialcontactsV1ListContactsResponse) MarshalJSON

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudEssentialcontactsV1SendTestMessageRequest: Request message for the SendTestMessage method.

func (*GoogleCloudEssentialcontactsV1SendTestMessageRequest) MarshalJSON

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); } The JSON representation for `Empty` is empty JSON object `{}`.

type OrganizationsContactsComputeCall

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

func (*OrganizationsContactsComputeCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsContactsComputeCall) Do

Do executes the "essentialcontacts.organizations.contacts.compute" call. Exactly one of *GoogleCloudEssentialcontactsV1ComputeContactsResponse or error will be non-nil. 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

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

func (*OrganizationsContactsComputeCall) Header

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

func (*OrganizationsContactsComputeCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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

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

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

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsContactsCreateCall) Do

Do executes the "essentialcontacts.organizations.contacts.create" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*OrganizationsContactsCreateCall) Header

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

type OrganizationsContactsDeleteCall

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

func (*OrganizationsContactsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsContactsDeleteCall) Do

Do executes the "essentialcontacts.organizations.contacts.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. 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

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

func (*OrganizationsContactsDeleteCall) Header

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

type OrganizationsContactsGetCall

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

func (*OrganizationsContactsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsContactsGetCall) Do

Do executes the "essentialcontacts.organizations.contacts.get" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*OrganizationsContactsGetCall) Header

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

func (*OrganizationsContactsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type OrganizationsContactsListCall

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

func (*OrganizationsContactsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsContactsListCall) Do

Do executes the "essentialcontacts.organizations.contacts.list" call. Exactly one of *GoogleCloudEssentialcontactsV1ListContactsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ListContactsResponse.ServerResponse.Hea der 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

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

func (*OrganizationsContactsListCall) Header

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

func (*OrganizationsContactsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OrganizationsContactsListCall) PageSize

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

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

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsContactsPatchCall) Do

Do executes the "essentialcontacts.organizations.contacts.patch" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*OrganizationsContactsPatchCall) Header

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

func (*OrganizationsContactsPatchCall) UpdateMask

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsContactsSendTestMessageCall) Do

Do executes the "essentialcontacts.organizations.contacts.sendTestMessage" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. 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

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

func (*OrganizationsContactsSendTestMessageCall) Header

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

type OrganizationsContactsService

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

func NewOrganizationsContactsService

func NewOrganizationsContactsService(s *Service) *OrganizationsContactsService

func (*OrganizationsContactsService) Compute

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

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

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

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: 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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsContactsComputeCall) Do

Do executes the "essentialcontacts.projects.contacts.compute" call. Exactly one of *GoogleCloudEssentialcontactsV1ComputeContactsResponse or error will be non-nil. 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

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

func (*ProjectsContactsComputeCall) Header

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

func (*ProjectsContactsComputeCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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

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

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

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsContactsCreateCall) Do

Do executes the "essentialcontacts.projects.contacts.create" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*ProjectsContactsCreateCall) Header

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

type ProjectsContactsDeleteCall

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

func (*ProjectsContactsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsContactsDeleteCall) Do

Do executes the "essentialcontacts.projects.contacts.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. 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

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

func (*ProjectsContactsDeleteCall) Header

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

type ProjectsContactsGetCall

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

func (*ProjectsContactsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsContactsGetCall) Do

Do executes the "essentialcontacts.projects.contacts.get" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*ProjectsContactsGetCall) Header

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

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

func (*ProjectsContactsGetCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsContactsListCall

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

func (*ProjectsContactsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsContactsListCall) Do

Do executes the "essentialcontacts.projects.contacts.list" call. Exactly one of *GoogleCloudEssentialcontactsV1ListContactsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudEssentialcontactsV1ListContactsResponse.ServerResponse.Hea der 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

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

func (*ProjectsContactsListCall) Header

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

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

func (*ProjectsContactsListCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsContactsListCall) PageSize

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

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsContactsPatchCall) Do

Do executes the "essentialcontacts.projects.contacts.patch" call. Exactly one of *GoogleCloudEssentialcontactsV1Contact or error will be non-nil. 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

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

func (*ProjectsContactsPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsContactsSendTestMessageCall) Do

Do executes the "essentialcontacts.projects.contacts.sendTestMessage" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. 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

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

func (*ProjectsContactsSendTestMessageCall) Header

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

type ProjectsContactsService

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

func NewProjectsContactsService

func NewProjectsContactsService(s *Service) *ProjectsContactsService

func (*ProjectsContactsService) Compute

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

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

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

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: 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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL