Class DeviceCode.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<DeviceCode.Builder>
com.google.protobuf.GeneratedMessage.Builder<DeviceCode.Builder>
com.soulfiremc.grpc.generated.DeviceCode.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DeviceCodeOrBuilder, Cloneable
Enclosing class:
DeviceCode
public static final class DeviceCode.Builder extends com.google.protobuf.GeneratedMessage.Builder<DeviceCode.Builder> implements DeviceCodeOrBuilder
Microsoft OAuth device code information for user authentication.
The user must visit the verification URI and enter the user code
to authorize the application.
Protobuf type soulfire.v1.DeviceCode

  • Method Summary

    Modifier and Type
    Method
    Description
    DeviceCode
    build()
     
    DeviceCode
    buildPartial()
     
    DeviceCode.Builder
    clear()
     
    DeviceCode.Builder
    clearDeviceCode()
    The device code used internally for polling authentication status.
    DeviceCode.Builder
    clearDirectVerificationUri()
    A URL that includes the user_code as a parameter for one-click verification.
    DeviceCode.Builder
    clearUserCode()
    The short alphanumeric code the user must enter at the verification URI.
    DeviceCode.Builder
    clearVerificationUri()
    The URL where the user must go to enter the user_code.
    DeviceCode
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getDeviceCode()
    The device code used internally for polling authentication status.
    com.google.protobuf.ByteString
    getDeviceCodeBytes()
    The device code used internally for polling authentication status.
    String
    getDirectVerificationUri()
    A URL that includes the user_code as a parameter for one-click verification.
    com.google.protobuf.ByteString
    getDirectVerificationUriBytes()
    A URL that includes the user_code as a parameter for one-click verification.
    String
    getUserCode()
    The short alphanumeric code the user must enter at the verification URI.
    com.google.protobuf.ByteString
    getUserCodeBytes()
    The short alphanumeric code the user must enter at the verification URI.
    String
    getVerificationUri()
    The URL where the user must go to enter the user_code.
    com.google.protobuf.ByteString
    getVerificationUriBytes()
    The URL where the user must go to enter the user_code.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    DeviceCode.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    DeviceCode.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    DeviceCode.Builder
    mergeFrom(DeviceCode other)
     
    DeviceCode.Builder
    setDeviceCode(String value)
    The device code used internally for polling authentication status.
    DeviceCode.Builder
    setDeviceCodeBytes(com.google.protobuf.ByteString value)
    The device code used internally for polling authentication status.
    DeviceCode.Builder
    setDirectVerificationUri(String value)
    A URL that includes the user_code as a parameter for one-click verification.
    DeviceCode.Builder
    setDirectVerificationUriBytes(com.google.protobuf.ByteString value)
    A URL that includes the user_code as a parameter for one-click verification.
    DeviceCode.Builder
    setUserCode(String value)
    The short alphanumeric code the user must enter at the verification URI.
    DeviceCode.Builder
    setUserCodeBytes(com.google.protobuf.ByteString value)
    The short alphanumeric code the user must enter at the verification URI.
    DeviceCode.Builder
    setVerificationUri(String value)
    The URL where the user must go to enter the user_code.
    DeviceCode.Builder
    setVerificationUriBytes(com.google.protobuf.ByteString value)
    The URL where the user must go to enter the user_code.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • 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.Builder<DeviceCode.Builder>

    • clear

      public DeviceCode.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<DeviceCode.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DeviceCode.Builder>

    • getDefaultInstanceForType

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

    • build

      public DeviceCode build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public DeviceCode buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public DeviceCode.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeviceCode.Builder>

    • mergeFrom

      public DeviceCode.Builder mergeFrom(DeviceCode other)

    • isInitialized

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

    • mergeFrom

      public DeviceCode.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DeviceCode.Builder>
      Throws:
      IOException

    • getDeviceCode

      public String getDeviceCode()
      The device code used internally for polling authentication status.
This is not shown to the user.
      string device_code = 1;
      Specified by:
      getDeviceCode in interface DeviceCodeOrBuilder
      Returns:
      The deviceCode.

    • getDeviceCodeBytes

      public com.google.protobuf.ByteString getDeviceCodeBytes()
      The device code used internally for polling authentication status.
This is not shown to the user.
      string device_code = 1;
      Specified by:
      getDeviceCodeBytes in interface DeviceCodeOrBuilder
      Returns:
      The bytes for deviceCode.

    • setDeviceCode

      public DeviceCode.Builder setDeviceCode(String value)
      The device code used internally for polling authentication status.
This is not shown to the user.
      string device_code = 1;
      Parameters:
      value - The deviceCode to set.
      Returns:
      This builder for chaining.

    • clearDeviceCode

      public DeviceCode.Builder clearDeviceCode()
      The device code used internally for polling authentication status.
This is not shown to the user.
      string device_code = 1;
      Returns:
      This builder for chaining.

    • setDeviceCodeBytes

      public DeviceCode.Builder setDeviceCodeBytes(com.google.protobuf.ByteString value)
      The device code used internally for polling authentication status.
This is not shown to the user.
      string device_code = 1;
      Parameters:
      value - The bytes for deviceCode to set.
      Returns:
      This builder for chaining.

    • getUserCode

      public String getUserCode()
      The short alphanumeric code the user must enter at the verification URI.
Typically displayed to the user for manual entry.
      string user_code = 2;
      Specified by:
      getUserCode in interface DeviceCodeOrBuilder
      Returns:
      The userCode.

    • getUserCodeBytes

      public com.google.protobuf.ByteString getUserCodeBytes()
      The short alphanumeric code the user must enter at the verification URI.
Typically displayed to the user for manual entry.
      string user_code = 2;
      Specified by:
      getUserCodeBytes in interface DeviceCodeOrBuilder
      Returns:
      The bytes for userCode.

    • setUserCode

      public DeviceCode.Builder setUserCode(String value)
      The short alphanumeric code the user must enter at the verification URI.
Typically displayed to the user for manual entry.
      string user_code = 2;
      Parameters:
      value - The userCode to set.
      Returns:
      This builder for chaining.

    • clearUserCode

      public DeviceCode.Builder clearUserCode()
      The short alphanumeric code the user must enter at the verification URI.
Typically displayed to the user for manual entry.
      string user_code = 2;
      Returns:
      This builder for chaining.

    • setUserCodeBytes

      public DeviceCode.Builder setUserCodeBytes(com.google.protobuf.ByteString value)
      The short alphanumeric code the user must enter at the verification URI.
Typically displayed to the user for manual entry.
      string user_code = 2;
      Parameters:
      value - The bytes for userCode to set.
      Returns:
      This builder for chaining.

    • getVerificationUri

      public String getVerificationUri()
      The URL where the user must go to enter the user_code.
Example: "https://microsoft.com/devicelogin"
      string verification_uri = 3;
      Specified by:
      getVerificationUri in interface DeviceCodeOrBuilder
      Returns:
      The verificationUri.

    • getVerificationUriBytes

      public com.google.protobuf.ByteString getVerificationUriBytes()
      The URL where the user must go to enter the user_code.
Example: "https://microsoft.com/devicelogin"
      string verification_uri = 3;
      Specified by:
      getVerificationUriBytes in interface DeviceCodeOrBuilder
      Returns:
      The bytes for verificationUri.

    • setVerificationUri

      public DeviceCode.Builder setVerificationUri(String value)
      The URL where the user must go to enter the user_code.
Example: "https://microsoft.com/devicelogin"
      string verification_uri = 3;
      Parameters:
      value - The verificationUri to set.
      Returns:
      This builder for chaining.

    • clearVerificationUri

      public DeviceCode.Builder clearVerificationUri()
      The URL where the user must go to enter the user_code.
Example: "https://microsoft.com/devicelogin"
      string verification_uri = 3;
      Returns:
      This builder for chaining.

    • setVerificationUriBytes

      public DeviceCode.Builder setVerificationUriBytes(com.google.protobuf.ByteString value)
      The URL where the user must go to enter the user_code.
Example: "https://microsoft.com/devicelogin"
      string verification_uri = 3;
      Parameters:
      value - The bytes for verificationUri to set.
      Returns:
      This builder for chaining.

    • getDirectVerificationUri

      public String getDirectVerificationUri()
      A URL that includes the user_code as a parameter for one-click verification.
Users can visit this URL directly without manually entering the code.
Example: "https://microsoft.com/devicelogin?otc=ABCD1234"
      string direct_verification_uri = 4;
      Specified by:
      getDirectVerificationUri in interface DeviceCodeOrBuilder
      Returns:
      The directVerificationUri.

    • getDirectVerificationUriBytes

      public com.google.protobuf.ByteString getDirectVerificationUriBytes()
      A URL that includes the user_code as a parameter for one-click verification.
Users can visit this URL directly without manually entering the code.
Example: "https://microsoft.com/devicelogin?otc=ABCD1234"
      string direct_verification_uri = 4;
      Specified by:
      getDirectVerificationUriBytes in interface DeviceCodeOrBuilder
      Returns:
      The bytes for directVerificationUri.

    • setDirectVerificationUri

      public DeviceCode.Builder setDirectVerificationUri(String value)
      A URL that includes the user_code as a parameter for one-click verification.
Users can visit this URL directly without manually entering the code.
Example: "https://microsoft.com/devicelogin?otc=ABCD1234"
      string direct_verification_uri = 4;
      Parameters:
      value - The directVerificationUri to set.
      Returns:
      This builder for chaining.

    • clearDirectVerificationUri

      public DeviceCode.Builder clearDirectVerificationUri()
      A URL that includes the user_code as a parameter for one-click verification.
Users can visit this URL directly without manually entering the code.
Example: "https://microsoft.com/devicelogin?otc=ABCD1234"
      string direct_verification_uri = 4;
      Returns:
      This builder for chaining.

    • setDirectVerificationUriBytes

      public DeviceCode.Builder setDirectVerificationUriBytes(com.google.protobuf.ByteString value)
      A URL that includes the user_code as a parameter for one-click verification.
Users can visit this URL directly without manually entering the code.
Example: "https://microsoft.com/devicelogin?otc=ABCD1234"
      string direct_verification_uri = 4;
      Parameters:
      value - The bytes for directVerificationUri to set.
      Returns:
      This builder for chaining.