Class FetchReportResultsRequest.Builder

  • All Implemented Interfaces:
    FetchReportResultsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    FetchReportResultsRequest

    public static final class FetchReportResultsRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<FetchReportResultsRequest.Builder>
    implements FetchReportResultsRequestOrBuilder
     Request message for
     [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults].
     
    Protobuf type google.cloud.channel.v1.FetchReportResultsRequest
    • Method Detail

      • 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.Builder<FetchReportResultsRequest.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.GeneratedMessageV3.Builder<FetchReportResultsRequest.Builder>
      • getDefaultInstanceForType

        public FetchReportResultsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public FetchReportResultsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  int index,
                                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FetchReportResultsRequest.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FetchReportResultsRequest.Builder>
      • mergeFrom

        public FetchReportResultsRequest.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<FetchReportResultsRequest.Builder>
        Throws:
        IOException
      • getReportJob

        public String getReportJob()
         Required. The report job created by
         [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
         Report_job uses the format:
         accounts/{account_id}/reportJobs/{report_job_id}
         
        string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getReportJob in interface FetchReportResultsRequestOrBuilder
        Returns:
        The reportJob.
      • getReportJobBytes

        public com.google.protobuf.ByteString getReportJobBytes()
         Required. The report job created by
         [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
         Report_job uses the format:
         accounts/{account_id}/reportJobs/{report_job_id}
         
        string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getReportJobBytes in interface FetchReportResultsRequestOrBuilder
        Returns:
        The bytes for reportJob.
      • setReportJob

        public FetchReportResultsRequest.Builder setReportJob​(String value)
         Required. The report job created by
         [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
         Report_job uses the format:
         accounts/{account_id}/reportJobs/{report_job_id}
         
        string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The reportJob to set.
        Returns:
        This builder for chaining.
      • clearReportJob

        public FetchReportResultsRequest.Builder clearReportJob()
         Required. The report job created by
         [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
         Report_job uses the format:
         accounts/{account_id}/reportJobs/{report_job_id}
         
        string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setReportJobBytes

        public FetchReportResultsRequest.Builder setReportJobBytes​(com.google.protobuf.ByteString value)
         Required. The report job created by
         [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
         Report_job uses the format:
         accounts/{account_id}/reportJobs/{report_job_id}
         
        string report_job = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for reportJob to set.
        Returns:
        This builder for chaining.
      • getPageSize

        public int getPageSize()
         Optional. Requested page size of the report. The server may return fewer
         results than requested. If you don't specify a page size, the server uses a
         sensible default (may change over time).
        
         The maximum value is 30,000; the server will change larger values to
         30,000.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface FetchReportResultsRequestOrBuilder
        Returns:
        The pageSize.
      • setPageSize

        public FetchReportResultsRequest.Builder setPageSize​(int value)
         Optional. Requested page size of the report. The server may return fewer
         results than requested. If you don't specify a page size, the server uses a
         sensible default (may change over time).
        
         The maximum value is 30,000; the server will change larger values to
         30,000.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.
      • clearPageSize

        public FetchReportResultsRequest.Builder clearPageSize()
         Optional. Requested page size of the report. The server may return fewer
         results than requested. If you don't specify a page size, the server uses a
         sensible default (may change over time).
        
         The maximum value is 30,000; the server will change larger values to
         30,000.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • getPageToken

        public String getPageToken()
         Optional. A token that specifies a page of results beyond the first page.
         Obtained through
         [FetchReportResultsResponse.next_page_token][google.cloud.channel.v1.FetchReportResultsResponse.next_page_token]
         of the previous
         [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]
         call.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface FetchReportResultsRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. A token that specifies a page of results beyond the first page.
         Obtained through
         [FetchReportResultsResponse.next_page_token][google.cloud.channel.v1.FetchReportResultsResponse.next_page_token]
         of the previous
         [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]
         call.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface FetchReportResultsRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • setPageToken

        public FetchReportResultsRequest.Builder setPageToken​(String value)
         Optional. A token that specifies a page of results beyond the first page.
         Obtained through
         [FetchReportResultsResponse.next_page_token][google.cloud.channel.v1.FetchReportResultsResponse.next_page_token]
         of the previous
         [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]
         call.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.
      • clearPageToken

        public FetchReportResultsRequest.Builder clearPageToken()
         Optional. A token that specifies a page of results beyond the first page.
         Obtained through
         [FetchReportResultsResponse.next_page_token][google.cloud.channel.v1.FetchReportResultsResponse.next_page_token]
         of the previous
         [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]
         call.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setPageTokenBytes

        public FetchReportResultsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Optional. A token that specifies a page of results beyond the first page.
         Obtained through
         [FetchReportResultsResponse.next_page_token][google.cloud.channel.v1.FetchReportResultsResponse.next_page_token]
         of the previous
         [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults]
         call.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.
      • getPartitionKeysList

        public com.google.protobuf.ProtocolStringList getPartitionKeysList()
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPartitionKeysList in interface FetchReportResultsRequestOrBuilder
        Returns:
        A list containing the partitionKeys.
      • getPartitionKeysCount

        public int getPartitionKeysCount()
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPartitionKeysCount in interface FetchReportResultsRequestOrBuilder
        Returns:
        The count of partitionKeys.
      • getPartitionKeys

        public String getPartitionKeys​(int index)
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPartitionKeys in interface FetchReportResultsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The partitionKeys at the given index.
      • getPartitionKeysBytes

        public com.google.protobuf.ByteString getPartitionKeysBytes​(int index)
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPartitionKeysBytes in interface FetchReportResultsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the partitionKeys at the given index.
      • setPartitionKeys

        public FetchReportResultsRequest.Builder setPartitionKeys​(int index,
                                                                  String value)
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index to set the value at.
        value - The partitionKeys to set.
        Returns:
        This builder for chaining.
      • addPartitionKeys

        public FetchReportResultsRequest.Builder addPartitionKeys​(String value)
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The partitionKeys to add.
        Returns:
        This builder for chaining.
      • addAllPartitionKeys

        public FetchReportResultsRequest.Builder addAllPartitionKeys​(Iterable<String> values)
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        values - The partitionKeys to add.
        Returns:
        This builder for chaining.
      • clearPartitionKeys

        public FetchReportResultsRequest.Builder clearPartitionKeys()
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • addPartitionKeysBytes

        public FetchReportResultsRequest.Builder addPartitionKeysBytes​(com.google.protobuf.ByteString value)
         Optional. List of keys specifying which report partitions to return.
         If empty, returns all partitions.
         
        repeated string partition_keys = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes of the partitionKeys to add.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final FetchReportResultsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FetchReportResultsRequest.Builder>
      • mergeUnknownFields

        public final FetchReportResultsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FetchReportResultsRequest.Builder>