Interface ListCompaniesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListCompaniesRequest, ListCompaniesRequest.Builder

    public interface ListCompaniesRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getPageSize()
      The maximum number of companies to be returned, at most 100.
      String getPageToken()
      The starting indicator from which to return results.
      com.google.protobuf.ByteString getPageTokenBytes()
      The starting indicator from which to return results.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      boolean getRequireOpenJobs()
      Set to true if the companies requested must have open jobs.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getParent

        String getParent()
         Required. Resource name of the tenant under which the company is created.
        
         The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         "projects/foo/tenant/bar".
        
         If tenant id is unspecified, the default tenant will be used, for
         example, "projects/foo".
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.
      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. Resource name of the tenant under which the company is created.
        
         The format is "projects/{project_id}/tenants/{tenant_id}", for example,
         "projects/foo/tenant/bar".
        
         If tenant id is unspecified, the default tenant will be used, for
         example, "projects/foo".
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.
      • getPageToken

        String getPageToken()
         The starting indicator from which to return results.
         
        string page_token = 2;
        Returns:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         The starting indicator from which to return results.
         
        string page_token = 2;
        Returns:
        The bytes for pageToken.
      • getPageSize

        int getPageSize()
         The maximum number of companies to be returned, at most 100.
         Default is 100 if a non-positive number is provided.
         
        int32 page_size = 3;
        Returns:
        The pageSize.
      • getRequireOpenJobs

        boolean getRequireOpenJobs()
         Set to true if the companies requested must have open jobs.
        
         Defaults to false.
        
         If true, at most
         [page_size][google.cloud.talent.v4beta1.ListCompaniesRequest.page_size] of
         companies are fetched, among which only those with open jobs are returned.
         
        bool require_open_jobs = 4;
        Returns:
        The requireOpenJobs.