Package cloud.google.com/go/essentialcontacts/apiv1/essentialcontactspb (v1.4.0)

Variables

NotificationCategory_name, NotificationCategory_value

var (
	NotificationCategory_name = map[int32]string{
		0:  "NOTIFICATION_CATEGORY_UNSPECIFIED",
		2:  "ALL",
		3:  "SUSPENSION",
		5:  "SECURITY",
		6:  "TECHNICAL",
		7:  "BILLING",
		8:  "LEGAL",
		9:  "PRODUCT_UPDATES",
		10: "TECHNICAL_INCIDENTS",
	}
	NotificationCategory_value = map[string]int32{
		"NOTIFICATION_CATEGORY_UNSPECIFIED": 0,
		"ALL":                               2,
		"SUSPENSION":                        3,
		"SECURITY":                          5,
		"TECHNICAL":                         6,
		"BILLING":                           7,
		"LEGAL":                             8,
		"PRODUCT_UPDATES":                   9,
		"TECHNICAL_INCIDENTS":               10,
	}
)

Enum value maps for NotificationCategory.

ValidationState_name, ValidationState_value

var (
	ValidationState_name = map[int32]string{
		0: "VALIDATION_STATE_UNSPECIFIED",
		1: "VALID",
		2: "INVALID",
	}
	ValidationState_value = map[string]int32{
		"VALIDATION_STATE_UNSPECIFIED": 0,
		"VALID":                        1,
		"INVALID":                      2,
	}
)

Enum value maps for ValidationState.

File_google_cloud_essentialcontacts_v1_enums_proto

var File_google_cloud_essentialcontacts_v1_enums_proto protoreflect.FileDescriptor

File_google_cloud_essentialcontacts_v1_service_proto

var File_google_cloud_essentialcontacts_v1_service_proto protoreflect.FileDescriptor

Functions

func RegisterEssentialContactsServiceServer 

func RegisterEssentialContactsServiceServer(s *grpc.Server, srv EssentialContactsServiceServer)

ComputeContactsRequest

type ComputeContactsRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`

	NotificationCategories []NotificationCategory "" /* 195 byte string literal not displayed */

	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`

	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`

}

Request message for the ComputeContacts method.

func (*ComputeContactsRequest) Descriptor 

func (*ComputeContactsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ComputeContactsRequest.ProtoReflect.Descriptor instead.

func (*ComputeContactsRequest) GetNotificationCategories 

func (x *ComputeContactsRequest) GetNotificationCategories() []NotificationCategory

func (*ComputeContactsRequest) GetPageSize 

func (x *ComputeContactsRequest) GetPageSize() int32

func (*ComputeContactsRequest) GetPageToken 

func (x *ComputeContactsRequest) GetPageToken() string

func (*ComputeContactsRequest) GetParent 

func (x *ComputeContactsRequest) GetParent() string

func (*ComputeContactsRequest) ProtoMessage 

func (*ComputeContactsRequest) ProtoMessage()

func (*ComputeContactsRequest) ProtoReflect 

func (x *ComputeContactsRequest) ProtoReflect() protoreflect.Message

func (*ComputeContactsRequest) Reset 

func (x *ComputeContactsRequest) Reset()

func (*ComputeContactsRequest) String 

func (x *ComputeContactsRequest) String() string

ComputeContactsResponse

type ComputeContactsResponse struct {

	// All contacts for the resource that are subscribed to the specified
	// notification categories, including contacts inherited from any parent
	// resources.
	Contacts []*Contact `protobuf:"bytes,1,rep,name=contacts,proto3" json:"contacts,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the ComputeContacts method.

func (*ComputeContactsResponse) Descriptor 

func (*ComputeContactsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ComputeContactsResponse.ProtoReflect.Descriptor instead.

func (*ComputeContactsResponse) GetContacts 

func (x *ComputeContactsResponse) GetContacts() []*Contact

func (*ComputeContactsResponse) GetNextPageToken 

func (x *ComputeContactsResponse) GetNextPageToken() string

func (*ComputeContactsResponse) ProtoMessage 

func (*ComputeContactsResponse) ProtoMessage()

func (*ComputeContactsResponse) ProtoReflect 

func (x *ComputeContactsResponse) ProtoReflect() protoreflect.Message

func (*ComputeContactsResponse) Reset 

func (x *ComputeContactsResponse) Reset()

func (*ComputeContactsResponse) String 

func (x *ComputeContactsResponse) String() string

Contact

type Contact struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	Email string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`

	NotificationCategorySubscriptions []NotificationCategory "" /* 230 byte string literal not displayed */

	LanguageTag string `protobuf:"bytes,4,opt,name=language_tag,json=languageTag,proto3" json:"language_tag,omitempty"`

	ValidationState ValidationState "" /* 162 byte string literal not displayed */

	ValidateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=validate_time,json=validateTime,proto3" json:"validate_time,omitempty"`

}

A contact that will receive notifications from Google Cloud.

func (*Contact) Descriptor 

func (*Contact) Descriptor() ([]byte, []int)

Deprecated: Use Contact.ProtoReflect.Descriptor instead.

func (*Contact) GetEmail 

func (x *Contact) GetEmail() string

func (*Contact) GetLanguageTag 

func (x *Contact) GetLanguageTag() string

func (*Contact) GetName 

func (x *Contact) GetName() string

func (*Contact) GetNotificationCategorySubscriptions 

func (x *Contact) GetNotificationCategorySubscriptions() []NotificationCategory

func (*Contact) GetValidateTime 

func (x *Contact) GetValidateTime() *timestamppb.Timestamp

func (*Contact) GetValidationState 

func (x *Contact) GetValidationState() ValidationState

func (*Contact) ProtoMessage 

func (*Contact) ProtoMessage()

func (*Contact) ProtoReflect 

func (x *Contact) ProtoReflect() protoreflect.Message

func (*Contact) Reset 

func (x *Contact) Reset()

func (*Contact) String 

func (x *Contact) String() string

CreateContactRequest

type CreateContactRequest struct {

	// Required. The resource to save this contact for.
	// Format: organizations/{organization_id}, folders/{folder_id} or
	// projects/{project_id}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The contact to create. Must specify an email address and language
	// tag.
	Contact *Contact `protobuf:"bytes,2,opt,name=contact,proto3" json:"contact,omitempty"`
	// contains filtered or unexported fields
}

Request message for the CreateContact method.

func (*CreateContactRequest) Descriptor 

func (*CreateContactRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateContactRequest.ProtoReflect.Descriptor instead.

func (*CreateContactRequest) GetContact 

func (x *CreateContactRequest) GetContact() *Contact

func (*CreateContactRequest) GetParent 

func (x *CreateContactRequest) GetParent() string

func (*CreateContactRequest) ProtoMessage 

func (*CreateContactRequest) ProtoMessage()

func (*CreateContactRequest) ProtoReflect 

func (x *CreateContactRequest) ProtoReflect() protoreflect.Message

func (*CreateContactRequest) Reset 

func (x *CreateContactRequest) Reset()

func (*CreateContactRequest) String 

func (x *CreateContactRequest) String() string

DeleteContactRequest

type DeleteContactRequest struct {

	// Required. 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}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the DeleteContact method.

func (*DeleteContactRequest) Descriptor 

func (*DeleteContactRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteContactRequest.ProtoReflect.Descriptor instead.

func (*DeleteContactRequest) GetName 

func (x *DeleteContactRequest) GetName() string

func (*DeleteContactRequest) ProtoMessage 

func (*DeleteContactRequest) ProtoMessage()

func (*DeleteContactRequest) ProtoReflect 

func (x *DeleteContactRequest) ProtoReflect() protoreflect.Message

func (*DeleteContactRequest) Reset 

func (x *DeleteContactRequest) Reset()

func (*DeleteContactRequest) String 

func (x *DeleteContactRequest) String() string

EssentialContactsServiceClient

type EssentialContactsServiceClient interface {
	// Adds a new contact for a resource.
	CreateContact(ctx context.Context, in *CreateContactRequest, opts ...grpc.CallOption) (*Contact, error)
	// Updates a contact.
	// Note: A contact's email address cannot be changed.
	UpdateContact(ctx context.Context, in *UpdateContactRequest, opts ...grpc.CallOption) (*Contact, error)
	// Lists the contacts that have been set on a resource.
	ListContacts(ctx context.Context, in *ListContactsRequest, opts ...grpc.CallOption) (*ListContactsResponse, error)
	// Gets a single contact.
	GetContact(ctx context.Context, in *GetContactRequest, opts ...grpc.CallOption) (*Contact, error)
	// Deletes a contact.
	DeleteContact(ctx context.Context, in *DeleteContactRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all contacts for the resource that are subscribed to the
	// specified notification categories, including contacts inherited from
	// any parent resources.
	ComputeContacts(ctx context.Context, in *ComputeContactsRequest, opts ...grpc.CallOption) (*ComputeContactsResponse, error)
	// Allows a contact admin to send a test message to contact to verify that it
	// has been configured correctly.
	SendTestMessage(ctx context.Context, in *SendTestMessageRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

EssentialContactsServiceClient is the client API for EssentialContactsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewEssentialContactsServiceClient 

func NewEssentialContactsServiceClient(cc grpc.ClientConnInterface) EssentialContactsServiceClient

EssentialContactsServiceServer

type EssentialContactsServiceServer interface {
	// Adds a new contact for a resource.
	CreateContact(context.Context, *CreateContactRequest) (*Contact, error)
	// Updates a contact.
	// Note: A contact's email address cannot be changed.
	UpdateContact(context.Context, *UpdateContactRequest) (*Contact, error)
	// Lists the contacts that have been set on a resource.
	ListContacts(context.Context, *ListContactsRequest) (*ListContactsResponse, error)
	// Gets a single contact.
	GetContact(context.Context, *GetContactRequest) (*Contact, error)
	// Deletes a contact.
	DeleteContact(context.Context, *DeleteContactRequest) (*emptypb.Empty, error)
	// Lists all contacts for the resource that are subscribed to the
	// specified notification categories, including contacts inherited from
	// any parent resources.
	ComputeContacts(context.Context, *ComputeContactsRequest) (*ComputeContactsResponse, error)
	// Allows a contact admin to send a test message to contact to verify that it
	// has been configured correctly.
	SendTestMessage(context.Context, *SendTestMessageRequest) (*emptypb.Empty, error)
}

EssentialContactsServiceServer is the server API for EssentialContactsService service.

GetContactRequest

type GetContactRequest struct {

	// Required. 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}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the GetContact method.

func (*GetContactRequest) Descriptor 

func (*GetContactRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetContactRequest.ProtoReflect.Descriptor instead.

func (*GetContactRequest) GetName 

func (x *GetContactRequest) GetName() string

func (*GetContactRequest) ProtoMessage 

func (*GetContactRequest) ProtoMessage()

func (*GetContactRequest) ProtoReflect 

func (x *GetContactRequest) ProtoReflect() protoreflect.Message

func (*GetContactRequest) Reset 

func (x *GetContactRequest) Reset()

func (*GetContactRequest) String 

func (x *GetContactRequest) String() string

ListContactsRequest

type ListContactsRequest struct {

	// Required. The parent resource name.
	// Format: organizations/{organization_id}, folders/{folder_id} or
	// projects/{project_id}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. 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.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. 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.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ListContacts method.

func (*ListContactsRequest) Descriptor 

func (*ListContactsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListContactsRequest.ProtoReflect.Descriptor instead.

func (*ListContactsRequest) GetPageSize 

func (x *ListContactsRequest) GetPageSize() int32

func (*ListContactsRequest) GetPageToken 

func (x *ListContactsRequest) GetPageToken() string

func (*ListContactsRequest) GetParent 

func (x *ListContactsRequest) GetParent() string

func (*ListContactsRequest) ProtoMessage 

func (*ListContactsRequest) ProtoMessage()

func (*ListContactsRequest) ProtoReflect 

func (x *ListContactsRequest) ProtoReflect() protoreflect.Message

func (*ListContactsRequest) Reset 

func (x *ListContactsRequest) Reset()

func (*ListContactsRequest) String 

func (x *ListContactsRequest) String() string

ListContactsResponse

type ListContactsResponse struct {

	// The contacts for the specified resource.
	Contacts []*Contact `protobuf:"bytes,1,rep,name=contacts,proto3" json:"contacts,omitempty"`
	// 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 `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the ListContacts method.

func (*ListContactsResponse) Descriptor 

func (*ListContactsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListContactsResponse.ProtoReflect.Descriptor instead.

func (*ListContactsResponse) GetContacts 

func (x *ListContactsResponse) GetContacts() []*Contact

func (*ListContactsResponse) GetNextPageToken 

func (x *ListContactsResponse) GetNextPageToken() string

func (*ListContactsResponse) ProtoMessage 

func (*ListContactsResponse) ProtoMessage()

func (*ListContactsResponse) ProtoReflect 

func (x *ListContactsResponse) ProtoReflect() protoreflect.Message

func (*ListContactsResponse) Reset 

func (x *ListContactsResponse) Reset()

func (*ListContactsResponse) String 

func (x *ListContactsResponse) String() string

NotificationCategory

type NotificationCategory int32

The notification categories that an essential contact can be subscribed to. Each notification will be categorized by the sender into one of the following categories. All contacts that are subscribed to that category will receive the notification.

const (
	// Notification category is unrecognized or unspecified.
	NotificationCategory_NOTIFICATION_CATEGORY_UNSPECIFIED NotificationCategory = 0
	// All notifications related to the resource, including notifications
	// pertaining to categories added in the future.
	NotificationCategory_ALL NotificationCategory = 2
	// Notifications related to imminent account suspension.
	NotificationCategory_SUSPENSION NotificationCategory = 3
	// Notifications related to security/privacy incidents, notifications, and
	// vulnerabilities.
	NotificationCategory_SECURITY NotificationCategory = 5
	// Notifications related to technical events and issues such as outages,
	// errors, or bugs.
	NotificationCategory_TECHNICAL NotificationCategory = 6
	// Notifications related to billing and payments notifications, price updates,
	// errors, or credits.
	NotificationCategory_BILLING NotificationCategory = 7
	// Notifications related to enforcement actions, regulatory compliance, or
	// government notices.
	NotificationCategory_LEGAL NotificationCategory = 8
	// Notifications related to new versions, product terms updates, or
	// deprecations.
	NotificationCategory_PRODUCT_UPDATES NotificationCategory = 9
	// Child category of TECHNICAL. If assigned, technical incident notifications
	// will go to these contacts instead of TECHNICAL.
	NotificationCategory_TECHNICAL_INCIDENTS NotificationCategory = 10
)

func (NotificationCategory) Descriptor 

func (NotificationCategory) Descriptor() protoreflect.EnumDescriptor

func (NotificationCategory) Enum 

func (x NotificationCategory) Enum() *NotificationCategory

func (NotificationCategory) EnumDescriptor 

func (NotificationCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotificationCategory.Descriptor instead.

func (NotificationCategory) Number 

func (x NotificationCategory) Number() protoreflect.EnumNumber

func (NotificationCategory) String 

func (x NotificationCategory) String() string

func (NotificationCategory) Type 

func (NotificationCategory) Type() protoreflect.EnumType

SendTestMessageRequest

type SendTestMessageRequest struct {
	Contacts []string `protobuf:"bytes,1,rep,name=contacts,proto3" json:"contacts,omitempty"`

	Resource string `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`

	NotificationCategory NotificationCategory "" /* 182 byte string literal not displayed */

}

Request message for the SendTestMessage method.

func (*SendTestMessageRequest) Descriptor 

func (*SendTestMessageRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendTestMessageRequest.ProtoReflect.Descriptor instead.

func (*SendTestMessageRequest) GetContacts 

func (x *SendTestMessageRequest) GetContacts() []string

func (*SendTestMessageRequest) GetNotificationCategory 

func (x *SendTestMessageRequest) GetNotificationCategory() NotificationCategory

func (*SendTestMessageRequest) GetResource 

func (x *SendTestMessageRequest) GetResource() string

func (*SendTestMessageRequest) ProtoMessage 

func (*SendTestMessageRequest) ProtoMessage()

func (*SendTestMessageRequest) ProtoReflect 

func (x *SendTestMessageRequest) ProtoReflect() protoreflect.Message

func (*SendTestMessageRequest) Reset 

func (x *SendTestMessageRequest) Reset()

func (*SendTestMessageRequest) String 

func (x *SendTestMessageRequest) String() string

UnimplementedEssentialContactsServiceServer

type UnimplementedEssentialContactsServiceServer struct {
}

UnimplementedEssentialContactsServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEssentialContactsServiceServer) ComputeContacts 

func (*UnimplementedEssentialContactsServiceServer) ComputeContacts(context.Context, *ComputeContactsRequest) (*ComputeContactsResponse, error)

func (*UnimplementedEssentialContactsServiceServer) CreateContact 

func (*UnimplementedEssentialContactsServiceServer) CreateContact(context.Context, *CreateContactRequest) (*Contact, error)

func (*UnimplementedEssentialContactsServiceServer) DeleteContact 

func (*UnimplementedEssentialContactsServiceServer) DeleteContact(context.Context, *DeleteContactRequest) (*emptypb.Empty, error)

func (*UnimplementedEssentialContactsServiceServer) GetContact 

func (*UnimplementedEssentialContactsServiceServer) GetContact(context.Context, *GetContactRequest) (*Contact, error)

func (*UnimplementedEssentialContactsServiceServer) ListContacts 

func (*UnimplementedEssentialContactsServiceServer) ListContacts(context.Context, *ListContactsRequest) (*ListContactsResponse, error)

func (*UnimplementedEssentialContactsServiceServer) SendTestMessage 

func (*UnimplementedEssentialContactsServiceServer) SendTestMessage(context.Context, *SendTestMessageRequest) (*emptypb.Empty, error)

func (*UnimplementedEssentialContactsServiceServer) UpdateContact 

func (*UnimplementedEssentialContactsServiceServer) UpdateContact(context.Context, *UpdateContactRequest) (*Contact, error)

UpdateContactRequest

type UpdateContactRequest struct {

	// Required. The contact resource to replace the existing saved contact. Note:
	// the email address of the contact cannot be modified.
	Contact *Contact `protobuf:"bytes,2,opt,name=contact,proto3" json:"contact,omitempty"`
	// Optional. The update mask applied to the resource. For the `FieldMask`
	// definition, see
	// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for the UpdateContact method.

func (*UpdateContactRequest) Descriptor 

func (*UpdateContactRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateContactRequest.ProtoReflect.Descriptor instead.

func (*UpdateContactRequest) GetContact 

func (x *UpdateContactRequest) GetContact() *Contact

func (*UpdateContactRequest) GetUpdateMask 

func (x *UpdateContactRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateContactRequest) ProtoMessage 

func (*UpdateContactRequest) ProtoMessage()

func (*UpdateContactRequest) ProtoReflect 

func (x *UpdateContactRequest) ProtoReflect() protoreflect.Message

func (*UpdateContactRequest) Reset 

func (x *UpdateContactRequest) Reset()

func (*UpdateContactRequest) String 

func (x *UpdateContactRequest) String() string

ValidationState

type ValidationState int32

A contact's validation state indicates whether or not it is the correct contact to be receiving notifications for a particular resource.

ValidationState_VALIDATION_STATE_UNSPECIFIED, ValidationState_VALID, ValidationState_INVALID

const (
	// The validation state is unknown or unspecified.
	ValidationState_VALIDATION_STATE_UNSPECIFIED ValidationState = 0
	// The contact is marked as valid. This is usually done manually by the
	// contact admin. All new contacts begin in the valid state.
	ValidationState_VALID ValidationState = 1
	// The contact is considered invalid. This may become the state if the
	// contact's email is found to be unreachable.
	ValidationState_INVALID ValidationState = 2
)

func (ValidationState) Descriptor 

func (ValidationState) Descriptor() protoreflect.EnumDescriptor

func (ValidationState) Enum 

func (x ValidationState) Enum() *ValidationState

func (ValidationState) EnumDescriptor 

func (ValidationState) EnumDescriptor() ([]byte, []int)

Deprecated: Use ValidationState.Descriptor instead.

func (ValidationState) Number 

func (x ValidationState) Number() protoreflect.EnumNumber

func (ValidationState) String 

func (x ValidationState) String() string

func (ValidationState) Type 

func (ValidationState) Type() protoreflect.EnumType