Class SendTestMessageRequest (2.33.0)

public final class SendTestMessageRequest extends GeneratedMessageV3 implements SendTestMessageRequestOrBuilder

Request message for the SendTestMessage method.

Protobuf type google.cloud.essentialcontacts.v1.SendTestMessageRequest

Static Fields

CONTACTS_FIELD_NUMBER

public static final int CONTACTS_FIELD_NUMBER
Field Value
TypeDescription
int

NOTIFICATION_CATEGORY_FIELD_NUMBER

public static final int NOTIFICATION_CATEGORY_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_FIELD_NUMBER

public static final int RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SendTestMessageRequest getDefaultInstance()
Returns
TypeDescription
SendTestMessageRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SendTestMessageRequest.Builder newBuilder()
Returns
TypeDescription
SendTestMessageRequest.Builder

newBuilder(SendTestMessageRequest prototype)

public static SendTestMessageRequest.Builder newBuilder(SendTestMessageRequest prototype)
Parameter
NameDescription
prototypeSendTestMessageRequest
Returns
TypeDescription
SendTestMessageRequest.Builder

parseDelimitedFrom(InputStream input)

public static SendTestMessageRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SendTestMessageRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SendTestMessageRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SendTestMessageRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SendTestMessageRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SendTestMessageRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SendTestMessageRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SendTestMessageRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SendTestMessageRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SendTestMessageRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SendTestMessageRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SendTestMessageRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SendTestMessageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SendTestMessageRequest> parser()
Returns
TypeDescription
Parser<SendTestMessageRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContacts(int index)

public String getContacts(int index)

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}

repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The contacts at the given index.

getContactsBytes(int index)

public ByteString getContactsBytes(int index)

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}

repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the contacts at the given index.

getContactsCount()

public int getContactsCount()

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}

repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
int

The count of contacts.

getContactsList()

public ProtocolStringList getContactsList()

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}

repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ProtocolStringList

A list containing the contacts.

getDefaultInstanceForType()

public SendTestMessageRequest getDefaultInstanceForType()
Returns
TypeDescription
SendTestMessageRequest

getNotificationCategory()

public NotificationCategory getNotificationCategory()

Required. The notification category to send the test message for. All contacts must be subscribed to this category.

.google.cloud.essentialcontacts.v1.NotificationCategory notification_category = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
NotificationCategory

The notificationCategory.

getNotificationCategoryValue()

public int getNotificationCategoryValue()

Required. The notification category to send the test message for. All contacts must be subscribed to this category.

.google.cloud.essentialcontacts.v1.NotificationCategory notification_category = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for notificationCategory.

getParserForType()

public Parser<SendTestMessageRequest> getParserForType()
Returns
TypeDescription
Parser<SendTestMessageRequest>
Overrides

getResource()

public String getResource()

Required. 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}

string resource = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The resource.

getResourceBytes()

public ByteString getResourceBytes()

Required. 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}

string resource = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for resource.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SendTestMessageRequest.Builder newBuilderForType()
Returns
TypeDescription
SendTestMessageRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SendTestMessageRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SendTestMessageRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SendTestMessageRequest.Builder toBuilder()
Returns
TypeDescription
SendTestMessageRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException