Class GoogleAdsField.Builder

  • All Implemented Interfaces:
    GoogleAdsFieldOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    GoogleAdsField

    public static final class GoogleAdsField.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<GoogleAdsField.Builder>
    implements GoogleAdsFieldOrBuilder
     A field or resource (artifact) used by GoogleAdsService.
     
    Protobuf type google.ads.googleads.v10.resources.GoogleAdsField
    • 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<GoogleAdsField.Builder>
      • clear

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

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

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

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

        public GoogleAdsField.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<GoogleAdsField.Builder>
      • setField

        public GoogleAdsField.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<GoogleAdsField.Builder>
      • clearField

        public GoogleAdsField.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GoogleAdsField.Builder>
      • clearOneof

        public GoogleAdsField.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GoogleAdsField.Builder>
      • setRepeatedField

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

        public GoogleAdsField.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GoogleAdsField.Builder>
      • mergeFrom

        public GoogleAdsField.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<GoogleAdsField.Builder>
      • isInitialized

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

        public GoogleAdsField.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.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<GoogleAdsField.Builder>
        Throws:
        java.io.IOException
      • getResourceName

        public java.lang.String getResourceName()
         Output only. The resource name of the artifact.
         Artifact resource names have the form:
         `googleAdsFields/{name}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface GoogleAdsFieldOrBuilder
        Returns:
        The resourceName.
      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Output only. The resource name of the artifact.
         Artifact resource names have the form:
         `googleAdsFields/{name}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface GoogleAdsFieldOrBuilder
        Returns:
        The bytes for resourceName.
      • setResourceName

        public GoogleAdsField.Builder setResourceName​(java.lang.String value)
         Output only. The resource name of the artifact.
         Artifact resource names have the form:
         `googleAdsFields/{name}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.
      • clearResourceName

        public GoogleAdsField.Builder clearResourceName()
         Output only. The resource name of the artifact.
         Artifact resource names have the form:
         `googleAdsFields/{name}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setResourceNameBytes

        public GoogleAdsField.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the artifact.
         Artifact resource names have the form:
         `googleAdsFields/{name}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.
      • hasName

        public boolean hasName()
         Output only. The name of the artifact.
         
        optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasName in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the name field is set.
      • getName

        public java.lang.String getName()
         Output only. The name of the artifact.
         
        optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface GoogleAdsFieldOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The name of the artifact.
         
        optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface GoogleAdsFieldOrBuilder
        Returns:
        The bytes for name.
      • setName

        public GoogleAdsField.Builder setName​(java.lang.String value)
         Output only. The name of the artifact.
         
        optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.
      • clearName

        public GoogleAdsField.Builder clearName()
         Output only. The name of the artifact.
         
        optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setNameBytes

        public GoogleAdsField.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. The name of the artifact.
         
        optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • getCategoryValue

        public int getCategoryValue()
         Output only. The category of the artifact.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCategoryValue in interface GoogleAdsFieldOrBuilder
        Returns:
        The enum numeric value on the wire for category.
      • setCategoryValue

        public GoogleAdsField.Builder setCategoryValue​(int value)
         Output only. The category of the artifact.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for category to set.
        Returns:
        This builder for chaining.
      • setCategory

        public GoogleAdsField.Builder setCategory​(GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory value)
         Output only. The category of the artifact.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The category to set.
        Returns:
        This builder for chaining.
      • clearCategory

        public GoogleAdsField.Builder clearCategory()
         Output only. The category of the artifact.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • hasSelectable

        public boolean hasSelectable()
         Output only. Whether the artifact can be used in a SELECT clause in search
         queries.
         
        optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSelectable in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the selectable field is set.
      • getSelectable

        public boolean getSelectable()
         Output only. Whether the artifact can be used in a SELECT clause in search
         queries.
         
        optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSelectable in interface GoogleAdsFieldOrBuilder
        Returns:
        The selectable.
      • setSelectable

        public GoogleAdsField.Builder setSelectable​(boolean value)
         Output only. Whether the artifact can be used in a SELECT clause in search
         queries.
         
        optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The selectable to set.
        Returns:
        This builder for chaining.
      • clearSelectable

        public GoogleAdsField.Builder clearSelectable()
         Output only. Whether the artifact can be used in a SELECT clause in search
         queries.
         
        optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • hasFilterable

        public boolean hasFilterable()
         Output only. Whether the artifact can be used in a WHERE clause in search
         queries.
         
        optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasFilterable in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the filterable field is set.
      • getFilterable

        public boolean getFilterable()
         Output only. Whether the artifact can be used in a WHERE clause in search
         queries.
         
        optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFilterable in interface GoogleAdsFieldOrBuilder
        Returns:
        The filterable.
      • setFilterable

        public GoogleAdsField.Builder setFilterable​(boolean value)
         Output only. Whether the artifact can be used in a WHERE clause in search
         queries.
         
        optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The filterable to set.
        Returns:
        This builder for chaining.
      • clearFilterable

        public GoogleAdsField.Builder clearFilterable()
         Output only. Whether the artifact can be used in a WHERE clause in search
         queries.
         
        optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • hasSortable

        public boolean hasSortable()
         Output only. Whether the artifact can be used in a ORDER BY clause in search
         queries.
         
        optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSortable in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the sortable field is set.
      • getSortable

        public boolean getSortable()
         Output only. Whether the artifact can be used in a ORDER BY clause in search
         queries.
         
        optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSortable in interface GoogleAdsFieldOrBuilder
        Returns:
        The sortable.
      • setSortable

        public GoogleAdsField.Builder setSortable​(boolean value)
         Output only. Whether the artifact can be used in a ORDER BY clause in search
         queries.
         
        optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The sortable to set.
        Returns:
        This builder for chaining.
      • clearSortable

        public GoogleAdsField.Builder clearSortable()
         Output only. Whether the artifact can be used in a ORDER BY clause in search
         queries.
         
        optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • getSelectableWithList

        public com.google.protobuf.ProtocolStringList getSelectableWithList()
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSelectableWithList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the selectableWith.
      • getSelectableWithCount

        public int getSelectableWithCount()
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSelectableWithCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of selectableWith.
      • getSelectableWith

        public java.lang.String getSelectableWith​(int index)
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSelectableWith in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The selectableWith at the given index.
      • getSelectableWithBytes

        public com.google.protobuf.ByteString getSelectableWithBytes​(int index)
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSelectableWithBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the selectableWith at the given index.
      • setSelectableWith

        public GoogleAdsField.Builder setSelectableWith​(int index,
                                                        java.lang.String value)
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index to set the value at.
        value - The selectableWith to set.
        Returns:
        This builder for chaining.
      • addSelectableWith

        public GoogleAdsField.Builder addSelectableWith​(java.lang.String value)
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The selectableWith to add.
        Returns:
        This builder for chaining.
      • addAllSelectableWith

        public GoogleAdsField.Builder addAllSelectableWith​(java.lang.Iterable<java.lang.String> values)
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        values - The selectableWith to add.
        Returns:
        This builder for chaining.
      • clearSelectableWith

        public GoogleAdsField.Builder clearSelectableWith()
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • addSelectableWithBytes

        public GoogleAdsField.Builder addSelectableWithBytes​(com.google.protobuf.ByteString value)
         Output only. The names of all resources, segments, and metrics that are selectable with
         the described artifact.
         
        repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes of the selectableWith to add.
        Returns:
        This builder for chaining.
      • getAttributeResourcesList

        public com.google.protobuf.ProtocolStringList getAttributeResourcesList()
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributeResourcesList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the attributeResources.
      • getAttributeResourcesCount

        public int getAttributeResourcesCount()
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributeResourcesCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of attributeResources.
      • getAttributeResources

        public java.lang.String getAttributeResources​(int index)
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributeResources in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The attributeResources at the given index.
      • getAttributeResourcesBytes

        public com.google.protobuf.ByteString getAttributeResourcesBytes​(int index)
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributeResourcesBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the attributeResources at the given index.
      • setAttributeResources

        public GoogleAdsField.Builder setAttributeResources​(int index,
                                                            java.lang.String value)
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index to set the value at.
        value - The attributeResources to set.
        Returns:
        This builder for chaining.
      • addAttributeResources

        public GoogleAdsField.Builder addAttributeResources​(java.lang.String value)
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The attributeResources to add.
        Returns:
        This builder for chaining.
      • addAllAttributeResources

        public GoogleAdsField.Builder addAllAttributeResources​(java.lang.Iterable<java.lang.String> values)
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        values - The attributeResources to add.
        Returns:
        This builder for chaining.
      • clearAttributeResources

        public GoogleAdsField.Builder clearAttributeResources()
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • addAttributeResourcesBytes

        public GoogleAdsField.Builder addAttributeResourcesBytes​(com.google.protobuf.ByteString value)
         Output only. The names of all resources that are selectable with the described
         artifact. Fields from these resources do not segment metrics when included
         in search queries.
         This field is only set for artifacts whose category is RESOURCE.
         
        repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes of the attributeResources to add.
        Returns:
        This builder for chaining.
      • getMetricsList

        public com.google.protobuf.ProtocolStringList getMetricsList()
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the metrics.
      • getMetricsCount

        public int getMetricsCount()
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of metrics.
      • getMetrics

        public java.lang.String getMetrics​(int index)
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetrics in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The metrics at the given index.
      • getMetricsBytes

        public com.google.protobuf.ByteString getMetricsBytes​(int index)
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the metrics at the given index.
      • setMetrics

        public GoogleAdsField.Builder setMetrics​(int index,
                                                 java.lang.String value)
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index to set the value at.
        value - The metrics to set.
        Returns:
        This builder for chaining.
      • addMetrics

        public GoogleAdsField.Builder addMetrics​(java.lang.String value)
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The metrics to add.
        Returns:
        This builder for chaining.
      • addAllMetrics

        public GoogleAdsField.Builder addAllMetrics​(java.lang.Iterable<java.lang.String> values)
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        values - The metrics to add.
        Returns:
        This builder for chaining.
      • clearMetrics

        public GoogleAdsField.Builder clearMetrics()
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • addMetricsBytes

        public GoogleAdsField.Builder addMetricsBytes​(com.google.protobuf.ByteString value)
         Output only. This field lists the names of all metrics that are selectable with the
         described artifact when it is used in the FROM clause.
         It is only set for artifacts whose category is RESOURCE.
         
        repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes of the metrics to add.
        Returns:
        This builder for chaining.
      • getSegmentsList

        public com.google.protobuf.ProtocolStringList getSegmentsList()
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSegmentsList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the segments.
      • getSegmentsCount

        public int getSegmentsCount()
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSegmentsCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of segments.
      • getSegments

        public java.lang.String getSegments​(int index)
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSegments in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The segments at the given index.
      • getSegmentsBytes

        public com.google.protobuf.ByteString getSegmentsBytes​(int index)
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSegmentsBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the segments at the given index.
      • setSegments

        public GoogleAdsField.Builder setSegments​(int index,
                                                  java.lang.String value)
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index to set the value at.
        value - The segments to set.
        Returns:
        This builder for chaining.
      • addSegments

        public GoogleAdsField.Builder addSegments​(java.lang.String value)
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The segments to add.
        Returns:
        This builder for chaining.
      • addAllSegments

        public GoogleAdsField.Builder addAllSegments​(java.lang.Iterable<java.lang.String> values)
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        values - The segments to add.
        Returns:
        This builder for chaining.
      • clearSegments

        public GoogleAdsField.Builder clearSegments()
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • addSegmentsBytes

        public GoogleAdsField.Builder addSegmentsBytes​(com.google.protobuf.ByteString value)
         Output only. This field lists the names of all artifacts, whether a segment or another
         resource, that segment metrics when included in search queries and when the
         described artifact is used in the FROM clause. It is only set for artifacts
         whose category is RESOURCE.
         
        repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes of the segments to add.
        Returns:
        This builder for chaining.
      • getEnumValuesList

        public com.google.protobuf.ProtocolStringList getEnumValuesList()
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEnumValuesList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the enumValues.
      • getEnumValuesCount

        public int getEnumValuesCount()
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEnumValuesCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of enumValues.
      • getEnumValues

        public java.lang.String getEnumValues​(int index)
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEnumValues in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The enumValues at the given index.
      • getEnumValuesBytes

        public com.google.protobuf.ByteString getEnumValuesBytes​(int index)
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEnumValuesBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the enumValues at the given index.
      • setEnumValues

        public GoogleAdsField.Builder setEnumValues​(int index,
                                                    java.lang.String value)
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        index - The index to set the value at.
        value - The enumValues to set.
        Returns:
        This builder for chaining.
      • addEnumValues

        public GoogleAdsField.Builder addEnumValues​(java.lang.String value)
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enumValues to add.
        Returns:
        This builder for chaining.
      • addAllEnumValues

        public GoogleAdsField.Builder addAllEnumValues​(java.lang.Iterable<java.lang.String> values)
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        values - The enumValues to add.
        Returns:
        This builder for chaining.
      • clearEnumValues

        public GoogleAdsField.Builder clearEnumValues()
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • addEnumValuesBytes

        public GoogleAdsField.Builder addEnumValuesBytes​(com.google.protobuf.ByteString value)
         Output only. Values the artifact can assume if it is a field of type ENUM.
         This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
         
        repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes of the enumValues to add.
        Returns:
        This builder for chaining.
      • getDataTypeValue

        public int getDataTypeValue()
         Output only. This field determines the operators that can be used with the artifact
         in WHERE clauses.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataTypeValue in interface GoogleAdsFieldOrBuilder
        Returns:
        The enum numeric value on the wire for dataType.
      • setDataTypeValue

        public GoogleAdsField.Builder setDataTypeValue​(int value)
         Output only. This field determines the operators that can be used with the artifact
         in WHERE clauses.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for dataType to set.
        Returns:
        This builder for chaining.
      • getDataType

        public GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType getDataType()
         Output only. This field determines the operators that can be used with the artifact
         in WHERE clauses.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataType in interface GoogleAdsFieldOrBuilder
        Returns:
        The dataType.
      • setDataType

        public GoogleAdsField.Builder setDataType​(GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType value)
         Output only. This field determines the operators that can be used with the artifact
         in WHERE clauses.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The dataType to set.
        Returns:
        This builder for chaining.
      • clearDataType

        public GoogleAdsField.Builder clearDataType()
         Output only. This field determines the operators that can be used with the artifact
         in WHERE clauses.
         
        .google.ads.googleads.v10.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • hasTypeUrl

        public boolean hasTypeUrl()
         Output only. The URL of proto describing the artifact's data type.
         
        optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasTypeUrl in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the typeUrl field is set.
      • getTypeUrl

        public java.lang.String getTypeUrl()
         Output only. The URL of proto describing the artifact's data type.
         
        optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeUrl in interface GoogleAdsFieldOrBuilder
        Returns:
        The typeUrl.
      • getTypeUrlBytes

        public com.google.protobuf.ByteString getTypeUrlBytes()
         Output only. The URL of proto describing the artifact's data type.
         
        optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeUrlBytes in interface GoogleAdsFieldOrBuilder
        Returns:
        The bytes for typeUrl.
      • setTypeUrl

        public GoogleAdsField.Builder setTypeUrl​(java.lang.String value)
         Output only. The URL of proto describing the artifact's data type.
         
        optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The typeUrl to set.
        Returns:
        This builder for chaining.
      • clearTypeUrl

        public GoogleAdsField.Builder clearTypeUrl()
         Output only. The URL of proto describing the artifact's data type.
         
        optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setTypeUrlBytes

        public GoogleAdsField.Builder setTypeUrlBytes​(com.google.protobuf.ByteString value)
         Output only. The URL of proto describing the artifact's data type.
         
        optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for typeUrl to set.
        Returns:
        This builder for chaining.
      • hasIsRepeated

        public boolean hasIsRepeated()
         Output only. Whether the field artifact is repeated.
         
        optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasIsRepeated in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the isRepeated field is set.
      • getIsRepeated

        public boolean getIsRepeated()
         Output only. Whether the field artifact is repeated.
         
        optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIsRepeated in interface GoogleAdsFieldOrBuilder
        Returns:
        The isRepeated.
      • setIsRepeated

        public GoogleAdsField.Builder setIsRepeated​(boolean value)
         Output only. Whether the field artifact is repeated.
         
        optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The isRepeated to set.
        Returns:
        This builder for chaining.
      • clearIsRepeated

        public GoogleAdsField.Builder clearIsRepeated()
         Output only. Whether the field artifact is repeated.
         
        optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final GoogleAdsField.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<GoogleAdsField.Builder>
      • mergeUnknownFields

        public final GoogleAdsField.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<GoogleAdsField.Builder>