Class PhoneNumber (4.64.0)

public final class PhoneNumber extends GeneratedMessageV3 implements PhoneNumberOrBuilder

Represents a phone number. PhoneNumber resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder.

Protobuf type google.cloud.dialogflow.v2beta1.PhoneNumber

Static Fields

CONVERSATION_PROFILE_FIELD_NUMBER

public static final int CONVERSATION_PROFILE_FIELD_NUMBER
Field Value
Type Description
int

LIFECYCLE_STATE_FIELD_NUMBER

public static final int LIFECYCLE_STATE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PHONE_NUMBER_FIELD_NUMBER

public static final int PHONE_NUMBER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PhoneNumber getDefaultInstance()
Returns
Type Description
PhoneNumber

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PhoneNumber.Builder newBuilder()
Returns
Type Description
PhoneNumber.Builder

newBuilder(PhoneNumber prototype)

public static PhoneNumber.Builder newBuilder(PhoneNumber prototype)
Parameter
Name Description
prototype PhoneNumber
Returns
Type Description
PhoneNumber.Builder

parseDelimitedFrom(InputStream input)

public static PhoneNumber parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PhoneNumber parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PhoneNumber parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PhoneNumber parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PhoneNumber parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PhoneNumber parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PhoneNumber parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PhoneNumber
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PhoneNumber> parser()
Returns
Type Description
Parser<PhoneNumber>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConversationProfile()

public String getConversationProfile()

Optional. The conversation profile calls to this PhoneNumber should use. The project ID here should be the same as the one in name. Format: projects/<Project ID>/conversationProfiles/<ConversationProfile ID>. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<ConversationProfile ID>.

string conversation_profile = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The conversationProfile.

getConversationProfileBytes()

public ByteString getConversationProfileBytes()

Optional. The conversation profile calls to this PhoneNumber should use. The project ID here should be the same as the one in name. Format: projects/<Project ID>/conversationProfiles/<ConversationProfile ID>. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<ConversationProfile ID>.

string conversation_profile = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for conversationProfile.

getDefaultInstanceForType()

public PhoneNumber getDefaultInstanceForType()
Returns
Type Description
PhoneNumber

getLifecycleState()

public PhoneNumber.LifecycleState getLifecycleState()

Output only. The state of the PhoneNumber. Defaults to ACTIVE. PhoneNumber objects set to DELETE_REQUESTED always decline incoming calls and can be removed completely within 30 days.

.google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState lifecycle_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PhoneNumber.LifecycleState

The lifecycleState.

getLifecycleStateValue()

public int getLifecycleStateValue()

Output only. The state of the PhoneNumber. Defaults to ACTIVE. PhoneNumber objects set to DELETE_REQUESTED always decline incoming calls and can be removed completely within 30 days.

.google.cloud.dialogflow.v2beta1.PhoneNumber.LifecycleState lifecycle_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for lifecycleState.

getName()

public String getName()

Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: projects/<Project ID>/phoneNumbers/<PhoneNumber ID>. Format: projects/<Project ID>/locations/<Location ID>/phoneNumbers/<PhoneNumber ID>.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: projects/<Project ID>/phoneNumbers/<PhoneNumber ID>. Format: projects/<Project ID>/locations/<Location ID>/phoneNumbers/<PhoneNumber ID>.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<PhoneNumber> getParserForType()
Returns
Type Description
Parser<PhoneNumber>
Overrides

getPhoneNumber()

public String getPhoneNumber()

Output only. Phone number in E.164 format. An example of a correctly formatted phone number: +15556767888.

string phone_number = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The phoneNumber.

getPhoneNumberBytes()

public ByteString getPhoneNumberBytes()

Output only. Phone number in E.164 format. An example of a correctly formatted phone number: +15556767888.

string phone_number = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for phoneNumber.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PhoneNumber.Builder newBuilderForType()
Returns
Type Description
PhoneNumber.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PhoneNumber.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PhoneNumber.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PhoneNumber.Builder toBuilder()
Returns
Type Description
PhoneNumber.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException