Class CompleteQueryRequest

  • All Implemented Interfaces:
    CompleteQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CompleteQueryRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements CompleteQueryRequestOrBuilder
     Auto-complete parameters.
     
    Protobuf type google.cloud.talent.v4.CompleteQueryRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getTenant

        public String getTenant()
         Required. Resource name of tenant the completion is performed within.
        
         The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         "projects/foo/tenants/bar".
         
        string tenant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getTenant in interface CompleteQueryRequestOrBuilder
        Returns:
        The tenant.
      • getTenantBytes

        public com.google.protobuf.ByteString getTenantBytes()
         Required. Resource name of tenant the completion is performed within.
        
         The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         "projects/foo/tenants/bar".
         
        string tenant = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getTenantBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for tenant.
      • getQuery

        public String getQuery()
         Required. The query used to generate suggestions.
        
         The maximum number of allowed characters is 255.
         
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQuery in interface CompleteQueryRequestOrBuilder
        Returns:
        The query.
      • getQueryBytes

        public com.google.protobuf.ByteString getQueryBytes()
         Required. The query used to generate suggestions.
        
         The maximum number of allowed characters is 255.
         
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQueryBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for query.
      • getLanguageCodesList

        public com.google.protobuf.ProtocolStringList getLanguageCodesList()
         The list of languages of the query. This is
         the BCP-47 language code, such as "en-US" or "sr-Latn".
         For more information, see
         [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
        
         The maximum number of allowed characters is 255.
         
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodesList in interface CompleteQueryRequestOrBuilder
        Returns:
        A list containing the languageCodes.
      • getLanguageCodesCount

        public int getLanguageCodesCount()
         The list of languages of the query. This is
         the BCP-47 language code, such as "en-US" or "sr-Latn".
         For more information, see
         [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
        
         The maximum number of allowed characters is 255.
         
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodesCount in interface CompleteQueryRequestOrBuilder
        Returns:
        The count of languageCodes.
      • getLanguageCodes

        public String getLanguageCodes​(int index)
         The list of languages of the query. This is
         the BCP-47 language code, such as "en-US" or "sr-Latn".
         For more information, see
         [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
        
         The maximum number of allowed characters is 255.
         
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodes in interface CompleteQueryRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The languageCodes at the given index.
      • getLanguageCodesBytes

        public com.google.protobuf.ByteString getLanguageCodesBytes​(int index)
         The list of languages of the query. This is
         the BCP-47 language code, such as "en-US" or "sr-Latn".
         For more information, see
         [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
        
         The maximum number of allowed characters is 255.
         
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodesBytes in interface CompleteQueryRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the languageCodes at the given index.
      • getPageSize

        public int getPageSize()
         Required. Completion result count.
        
         The maximum allowed page size is 10.
         
        int32 page_size = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPageSize in interface CompleteQueryRequestOrBuilder
        Returns:
        The pageSize.
      • getCompany

        public String getCompany()
         If provided, restricts completion to specified company.
        
         The format is
         "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
         example, "projects/foo/tenants/bar/companies/baz".
         
        string company = 5 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCompany in interface CompleteQueryRequestOrBuilder
        Returns:
        The company.
      • getCompanyBytes

        public com.google.protobuf.ByteString getCompanyBytes()
         If provided, restricts completion to specified company.
        
         The format is
         "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
         example, "projects/foo/tenants/bar/companies/baz".
         
        string company = 5 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCompanyBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for company.
      • getScopeValue

        public int getScopeValue()
         The scope of the completion. The defaults is
         [CompletionScope.PUBLIC][google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC].
         
        .google.cloud.talent.v4.CompleteQueryRequest.CompletionScope scope = 6;
        Specified by:
        getScopeValue in interface CompleteQueryRequestOrBuilder
        Returns:
        The enum numeric value on the wire for scope.
      • getScope

        public CompleteQueryRequest.CompletionScope getScope()
         The scope of the completion. The defaults is
         [CompletionScope.PUBLIC][google.cloud.talent.v4.CompleteQueryRequest.CompletionScope.PUBLIC].
         
        .google.cloud.talent.v4.CompleteQueryRequest.CompletionScope scope = 6;
        Specified by:
        getScope in interface CompleteQueryRequestOrBuilder
        Returns:
        The scope.
      • getTypeValue

        public int getTypeValue()
         The completion topic. The default is
         [CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED].
         
        .google.cloud.talent.v4.CompleteQueryRequest.CompletionType type = 7;
        Specified by:
        getTypeValue in interface CompleteQueryRequestOrBuilder
        Returns:
        The enum numeric value on the wire for type.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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 CompleteQueryRequest parseFrom​(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static CompleteQueryRequest parseFrom​(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        protected CompleteQueryRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<CompleteQueryRequest> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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