--- schema_version: "1" id: 4101d4e2c1d051dfe8a452f3fbc47ebff230805b042c8b06b2c12e5aa75a7759 title: BucketField Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_reports_BucketField.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm source_site: developer.salesforce.com content_type: documentation content_hash: cae6317b1e090c1080ad673dc7a8c552e9a74e32fd00024091aacafa3359be59 description: Contains methods and constructors to work with information about a bucket field, including bucket type, name, and bucketed values.Creates an instance of the Reports.BucketField class using the specified parameters.Creates an instance of the Reports.BucketField class. You can then set values by using the class’s set methods.Returns the bucket type.Returns the bucket’s API name.Returns the user-facing name of the bucket.Returns true if null values are converted to the number zero, otherwise returns false.Returns the name of fields grouped as Other in buckets of type PICKLIST.Returns the API name of the bucketed field.Returns the report values grouped by the bucket field.Sets the BucketType of the bucket.Sets the BucketType of the bucket.Sets the API name of the bucket.Sets the user-facing name of the bucket.Specifies whether null values in the bucket are converted to zero (true) or not (false).Sets the name of the fields grouped as Other (in buckets of BucketType PICKLIST).Specifies the name of the bucketed field.Specifies which type of values are included in the bucket.Returns a string. --- # BucketField Class Contains methods and constructors to work with information about a bucket field, including bucket type, name, and bucketed values. ## Namespace [Reports](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_Reports.htm "The Reports namespace provides classes for accessing the same data as is available in the Salesforce Reports and Dashboards REST API.") - **[BucketField Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_constructors)** - **[BucketField Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_methods)** ## BucketField Constructors The following are constructors for BucketField. - **[BucketField(bucketType, devloperName, label, nullTreatedAsZero, otherBucketLabel, sourceColumnName, values)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_ctor)** Creates an instance of the Reports.BucketField class using the specified parameters. - **[BucketField()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_ctor_2)** Creates an instance of the Reports.BucketField class. You can then set values by using the class’s set methods. ### BucketField(bucketType, devloperName, label, nullTreatedAsZero, otherBucketLabel, sourceColumnName, values) Creates an instance of the Reports.BucketField class using the specified parameters. #### Signature public BucketField(Reports.BucketType bucketType, String devloperName, String label, Boolean nullTreatedAsZero, String otherBucketLabel, String sourceColumnName, List values) #### Parameters - **bucketType**: Type: [Reports.BucketType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_BucketType.htm#apex_enum_reports_BucketType "The types of values included in a bucket.") The type of bucket. - **devloperName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") API name of the bucket. - **label**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") User-facing name of the bucket. - **nullTreatedAsZero**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") Specifies whether null values are converted to zero (true) or not (false). - **otherBucketLabel**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Name of the fields grouped as Other (in buckets of BucketType PICKLIST). - **sourceColumnName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") Name of the bucketed field. - **values**: Type: List<[Reports.BucketType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_BucketType.htm#apex_enum_reports_BucketType "The types of values included in a bucket.")\> Types of the values included in the bucket. ### BucketField() Creates an instance of the Reports.BucketField class. You can then set values by using the class’s set methods. #### Signature public BucketField() ## BucketField Methods The following are methods for BucketField. - **[getBucketType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_getBucketType)** Returns the bucket type. - **[getDevloperName()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_getDevloperName)** Returns the bucket’s API name. - **[getLabel()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_getLabel)** Returns the user-facing name of the bucket. - **[getNullTreatedAsZero()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_getNullTreatedAsZero)** Returns true if null values are converted to the number zero, otherwise returns false. - **[getOtherBucketLabel()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_getOtherBucketLabel)** Returns the name of fields grouped as Other in buckets of type PICKLIST. - **[getSourceColumnName()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_getSourceColumnName)** Returns the API name of the bucketed field. - **[getValues()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_getValues)** Returns the report values grouped by the bucket field. - **[setBucketType(value)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setBucketType)** Sets the BucketType of the bucket. - **[setBucketType(bucketType)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setBucketType_2)** Sets the BucketType of the bucket. - **[setDevloperName(devloperName)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setDevloperName)** Sets the API name of the bucket. - **[setLabel(label)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setLabel)** Sets the user-facing name of the bucket. - **[setNullTreatedAsZero(nullTreatedAsZero)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setNullTreatedAsZero)** Specifies whether null values in the bucket are converted to zero (true) or not (false). - **[setOtherBucketLabel(otherBucketLabel)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setOtherBucketLabel)** Sets the name of the fields grouped as Other (in buckets of BucketType PICKLIST). - **[setSourceColumnName(sourceColumnName)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setSourceColumnName)** Specifies the name of the bucketed field. - **[setValues(values)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_setValues)** Specifies which type of values are included in the bucket. - **[toString()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketField.htm#apex_reports_BucketField_toString)** Returns a string. ### getBucketType() Returns the bucket type. #### Signature public Reports.BucketType getBucketType() #### Return Value Type: [Reports.BucketType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_BucketType.htm#apex_enum_reports_BucketType "The types of values included in a bucket.") ### getDevloperName() Returns the bucket’s API name. #### Signature public String getDevloperName() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getLabel() Returns the user-facing name of the bucket. #### Signature public String getLabel() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getNullTreatedAsZero() Returns true if null values are converted to the number zero, otherwise returns false. #### Signature public Boolean getNullTreatedAsZero() #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") ### getOtherBucketLabel() Returns the name of fields grouped as Other in buckets of type PICKLIST. #### Signature public String getOtherBucketLabel() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getSourceColumnName() Returns the API name of the bucketed field. #### Signature public String getSourceColumnName() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getValues() Returns the report values grouped by the bucket field. #### Signature public List getValues() #### Return Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.BucketFieldValue](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketFieldValue.htm#apex_class_reports_BucketFieldValue "Contains information about the report values included in a bucket field.")\> ### setBucketType(value) Sets the BucketType of the bucket. #### Signature public void setBucketType(String value) #### Parameters - **value**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") See the [Reports.BucketType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_BucketType.htm#apex_enum_reports_BucketType "The types of values included in a bucket.") enum for valid values. #### Return Value Type: void ### setBucketType(bucketType) Sets the BucketType of the bucket. #### Signature public void setBucketType(Reports.BucketType bucketType) #### Parameters - **bucketType**: Type: [Reports.BucketType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_BucketType.htm#apex_enum_reports_BucketType "The types of values included in a bucket.") #### Return Value Type: void ### setDevloperName(devloperName) Sets the API name of the bucket. #### Signature public void setDevloperName(String devloperName) #### Parameters - **devloperName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The API name to assign to the bucket. #### Return Value Type: void ### setLabel(label) Sets the user-facing name of the bucket. #### Signature public void setLabel(String label) #### Parameters - **label**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setNullTreatedAsZero(nullTreatedAsZero) Specifies whether null values in the bucket are converted to zero (true) or not (false). #### Signature public void setNullTreatedAsZero(Boolean nullTreatedAsZero) #### Parameters - **nullTreatedAsZero**: Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_boolean.htm#apex_methods_system_boolean "Contains methods for the Boolean primitive data type.") #### Return Value Type: void ### setOtherBucketLabel(otherBucketLabel) Sets the name of the fields grouped as Other (in buckets of BucketType PICKLIST). #### Signature public void setOtherBucketLabel(String otherBucketLabel) #### Parameters - **otherBucketLabel**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setSourceColumnName(sourceColumnName) Specifies the name of the bucketed field. #### Signature public void setSourceColumnName(String sourceColumnName) #### Parameters - **sourceColumnName**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setValues(values) Specifies which type of values are included in the bucket. #### Signature public void setValues(List values) #### Parameters - **values**: Type: [List](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list "Contains methods for the List collection type.")<[Reports.BucketFieldValue](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_BucketFieldValue.htm#apex_class_reports_BucketFieldValue "Contains information about the report values included in a bucket field.")\> #### Return Value Type: void ### toString() Returns a string. #### Signature public String toString() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")