Package com.google.cloud.dialogflow.v2beta1

Class PhoneNumber

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2beta1.PhoneNumber
All Implemented Interfaces:
PhoneNumberOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PhoneNumber extends com.google.protobuf.GeneratedMessage 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][google.cloud.dialogflow.v2beta1.PhoneNumberOrder].
Protobuf type google.cloud.dialogflow.v2beta1.PhoneNumber
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • PHONE_NUMBER_FIELD_NUMBER

      public static final int PHONE_NUMBER_FIELD_NUMBER
      See Also:

    • CONVERSATION_PROFILE_FIELD_NUMBER

      public static final int CONVERSATION_PROFILE_FIELD_NUMBER
      See Also:

    • LIFECYCLE_STATE_FIELD_NUMBER

      public static final int LIFECYCLE_STATE_FIELD_NUMBER
      See Also:

    • ALLOWED_SIP_TRUNKS_FIELD_NUMBER

      public static final int ALLOWED_SIP_TRUNKS_FIELD_NUMBER
      See Also:

    • PURGE_TIME_FIELD_NUMBER

      public static final int PURGE_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getInboundRestrictionCase

      public PhoneNumber.InboundRestrictionCase getInboundRestrictionCase()
      Specified by:
      getInboundRestrictionCase in interface PhoneNumberOrBuilder

    • getName

      public String getName()
       Optional. The unique identifier of this phone number.
 Required for
 [PhoneNumbers.UpdatePhoneNumber][google.cloud.dialogflow.v2beta1.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];
      Specified by:
      getName in interface PhoneNumberOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Optional. The unique identifier of this phone number.
 Required for
 [PhoneNumbers.UpdatePhoneNumber][google.cloud.dialogflow.v2beta1.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];
      Specified by:
      getNameBytes in interface PhoneNumberOrBuilder
      Returns:
      The bytes for name.

    • getPhoneNumber

      public String getPhoneNumber()
       Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164)
 format. An example of a correctly formatted phone number: +15556767888.
      string phone_number = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPhoneNumber in interface PhoneNumberOrBuilder
      Returns:
      The phoneNumber.

    • getPhoneNumberBytes

      public com.google.protobuf.ByteString getPhoneNumberBytes()
       Output only. Phone number in [E.164](https://en.wikipedia.org/wiki/E.164)
 format. An example of a correctly formatted phone number: +15556767888.
      string phone_number = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPhoneNumberBytes in interface PhoneNumberOrBuilder
      Returns:
      The bytes for phoneNumber.

    • 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][google.cloud.dialogflow.v2beta1.PhoneNumber.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];
      Specified by:
      getConversationProfile in interface PhoneNumberOrBuilder
      Returns:
      The conversationProfile.

    • getConversationProfileBytes

      public com.google.protobuf.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][google.cloud.dialogflow.v2beta1.PhoneNumber.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];
      Specified by:
      getConversationProfileBytes in interface PhoneNumberOrBuilder
      Returns:
      The bytes for conversationProfile.

    • 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];
      Specified by:
      getLifecycleStateValue in interface PhoneNumberOrBuilder
      Returns:
      The enum numeric value on the wire for lifecycleState.

    • 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];
      Specified by:
      getLifecycleState in interface PhoneNumberOrBuilder
      Returns:
      The lifecycleState.

    • hasAllowedSipTrunks

      public boolean hasAllowedSipTrunks()
       Optional. Only allow calls from the specified SIP trunks.
      .google.cloud.dialogflow.v2beta1.PhoneNumber.AllowedSipTrunks allowed_sip_trunks = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAllowedSipTrunks in interface PhoneNumberOrBuilder
      Returns:
      Whether the allowedSipTrunks field is set.

    • getAllowedSipTrunks

      public PhoneNumber.AllowedSipTrunks getAllowedSipTrunks()
       Optional. Only allow calls from the specified SIP trunks.
      .google.cloud.dialogflow.v2beta1.PhoneNumber.AllowedSipTrunks allowed_sip_trunks = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedSipTrunks in interface PhoneNumberOrBuilder
      Returns:
      The allowedSipTrunks.

    • getAllowedSipTrunksOrBuilder

      public PhoneNumber.AllowedSipTrunksOrBuilder getAllowedSipTrunksOrBuilder()
       Optional. Only allow calls from the specified SIP trunks.
      .google.cloud.dialogflow.v2beta1.PhoneNumber.AllowedSipTrunks allowed_sip_trunks = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedSipTrunksOrBuilder in interface PhoneNumberOrBuilder

    • hasPurgeTime

      public boolean hasPurgeTime()
       Output only. The time at which this resource will be purged.
      .google.protobuf.Timestamp purge_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasPurgeTime in interface PhoneNumberOrBuilder
      Returns:
      Whether the purgeTime field is set.

    • getPurgeTime

      public com.google.protobuf.Timestamp getPurgeTime()
       Output only. The time at which this resource will be purged.
      .google.protobuf.Timestamp purge_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPurgeTime in interface PhoneNumberOrBuilder
      Returns:
      The purgeTime.

    • getPurgeTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getPurgeTimeOrBuilder()
       Output only. The time at which this resource will be purged.
      .google.protobuf.Timestamp purge_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPurgeTimeOrBuilder in interface PhoneNumberOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PhoneNumber parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PhoneNumber parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PhoneNumber parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PhoneNumber parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PhoneNumber parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PhoneNumber parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PhoneNumber parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PhoneNumber parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PhoneNumber parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PhoneNumber parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PhoneNumber parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PhoneNumber parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PhoneNumber.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PhoneNumber.Builder newBuilder()

    • newBuilder

      public static PhoneNumber.Builder newBuilder(PhoneNumber prototype)

    • toBuilder

      public PhoneNumber.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PhoneNumber.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PhoneNumber getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PhoneNumber> parser()

    • getParserForType

      public com.google.protobuf.Parser<PhoneNumber> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PhoneNumber getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder