Class Goal.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Goal.Builder>
com.google.ads.googleads.v22.resources.Goal.Builder
All Implemented Interfaces:
GoalOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Goal

public static final class Goal.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Goal.Builder> implements GoalOrBuilder
 Representation of goals.
 
Protobuf type google.ads.googleads.v22.resources.Goal
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Goal.Builder>
    • clear

      public Goal.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<Goal.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.GeneratedMessage.Builder<Goal.Builder>
    • getDefaultInstanceForType

      public Goal getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public Goal.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<Goal.Builder>
    • setField

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

      public Goal.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<Goal.Builder>
    • clearOneof

      public Goal.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<Goal.Builder>
    • setRepeatedField

      public Goal.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<Goal.Builder>
    • addRepeatedField

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

      public Goal.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<Goal.Builder>
    • mergeFrom

      public Goal.Builder mergeFrom(Goal other)
    • isInitialized

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

      public Goal.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<Goal.Builder>
      Throws:
      IOException
    • getGoalSettingsCase

      public Goal.GoalSettingsCase getGoalSettingsCase()
      Specified by:
      getGoalSettingsCase in interface GoalOrBuilder
    • clearGoalSettings

      public Goal.Builder clearGoalSettings()
    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the goal.
       Goal resource names have the form:
       `customers/{customer_id}/goals/{goal_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface GoalOrBuilder
      Returns:
      The resourceName.
    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the goal.
       Goal resource names have the form:
       `customers/{customer_id}/goals/{goal_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface GoalOrBuilder
      Returns:
      The bytes for resourceName.
    • setResourceName

      public Goal.Builder setResourceName(String value)
       Immutable. The resource name of the goal.
       Goal resource names have the form:
       `customers/{customer_id}/goals/{goal_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The resourceName to set.
      Returns:
      This builder for chaining.
    • clearResourceName

      public Goal.Builder clearResourceName()
       Immutable. The resource name of the goal.
       Goal resource names have the form:
       `customers/{customer_id}/goals/{goal_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setResourceNameBytes

      public Goal.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name of the goal.
       Goal resource names have the form:
       `customers/{customer_id}/goals/{goal_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for resourceName to set.
      Returns:
      This builder for chaining.
    • hasGoalId

      public boolean hasGoalId()
       Output only. The ID of this goal.
       
      optional int64 goal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasGoalId in interface GoalOrBuilder
      Returns:
      Whether the goalId field is set.
    • getGoalId

      public long getGoalId()
       Output only. The ID of this goal.
       
      optional int64 goal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalId in interface GoalOrBuilder
      Returns:
      The goalId.
    • setGoalId

      public Goal.Builder setGoalId(long value)
       Output only. The ID of this goal.
       
      optional int64 goal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The goalId to set.
      Returns:
      This builder for chaining.
    • clearGoalId

      public Goal.Builder clearGoalId()
       Output only. The ID of this goal.
       
      optional int64 goal_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • getGoalTypeValue

      public int getGoalTypeValue()
       Output only. The type of this goal.
       
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalTypeValue in interface GoalOrBuilder
      Returns:
      The enum numeric value on the wire for goalType.
    • setGoalTypeValue

      public Goal.Builder setGoalTypeValue(int value)
       Output only. The type of this goal.
       
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for goalType to set.
      Returns:
      This builder for chaining.
    • getGoalType

      public GoalTypeEnum.GoalType getGoalType()
       Output only. The type of this goal.
       
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGoalType in interface GoalOrBuilder
      Returns:
      The goalType.
    • setGoalType

      public Goal.Builder setGoalType(GoalTypeEnum.GoalType value)
       Output only. The type of this goal.
       
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The goalType to set.
      Returns:
      This builder for chaining.
    • clearGoalType

      public Goal.Builder clearGoalType()
       Output only. The type of this goal.
       
      .google.ads.googleads.v22.enums.GoalTypeEnum.GoalType goal_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • hasOwnerCustomer

      public boolean hasOwnerCustomer()
       Output only. The resource name of the goal owner customer.
       
      optional string owner_customer = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      hasOwnerCustomer in interface GoalOrBuilder
      Returns:
      Whether the ownerCustomer field is set.
    • getOwnerCustomer

      public String getOwnerCustomer()
       Output only. The resource name of the goal owner customer.
       
      optional string owner_customer = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getOwnerCustomer in interface GoalOrBuilder
      Returns:
      The ownerCustomer.
    • getOwnerCustomerBytes

      public com.google.protobuf.ByteString getOwnerCustomerBytes()
       Output only. The resource name of the goal owner customer.
       
      optional string owner_customer = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getOwnerCustomerBytes in interface GoalOrBuilder
      Returns:
      The bytes for ownerCustomer.
    • setOwnerCustomer

      public Goal.Builder setOwnerCustomer(String value)
       Output only. The resource name of the goal owner customer.
       
      optional string owner_customer = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The ownerCustomer to set.
      Returns:
      This builder for chaining.
    • clearOwnerCustomer

      public Goal.Builder clearOwnerCustomer()
       Output only. The resource name of the goal owner customer.
       
      optional string owner_customer = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setOwnerCustomerBytes

      public Goal.Builder setOwnerCustomerBytes(com.google.protobuf.ByteString value)
       Output only. The resource name of the goal owner customer.
       
      optional string owner_customer = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for ownerCustomer to set.
      Returns:
      This builder for chaining.
    • getOptimizationEligibilityValue

      public int getOptimizationEligibilityValue()
       Output only. Indicates if this goal is eligible for campaign optimization.
       
      .google.ads.googleads.v22.enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOptimizationEligibilityValue in interface GoalOrBuilder
      Returns:
      The enum numeric value on the wire for optimizationEligibility.
    • setOptimizationEligibilityValue

      public Goal.Builder setOptimizationEligibilityValue(int value)
       Output only. Indicates if this goal is eligible for campaign optimization.
       
      .google.ads.googleads.v22.enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for optimizationEligibility to set.
      Returns:
      This builder for chaining.
    • getOptimizationEligibility

       Output only. Indicates if this goal is eligible for campaign optimization.
       
      .google.ads.googleads.v22.enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOptimizationEligibility in interface GoalOrBuilder
      Returns:
      The optimizationEligibility.
    • setOptimizationEligibility

       Output only. Indicates if this goal is eligible for campaign optimization.
       
      .google.ads.googleads.v22.enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The optimizationEligibility to set.
      Returns:
      This builder for chaining.
    • clearOptimizationEligibility

      public Goal.Builder clearOptimizationEligibility()
       Output only. Indicates if this goal is eligible for campaign optimization.
       
      .google.ads.googleads.v22.enums.GoalOptimizationEligibilityEnum.GoalOptimizationEligibility optimization_eligibility = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • hasRetentionGoalSettings

      public boolean hasRetentionGoalSettings()
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Specified by:
      hasRetentionGoalSettings in interface GoalOrBuilder
      Returns:
      Whether the retentionGoalSettings field is set.
    • getRetentionGoalSettings

      public GoalSetting.RetentionGoal getRetentionGoalSettings()
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Specified by:
      getRetentionGoalSettings in interface GoalOrBuilder
      Returns:
      The retentionGoalSettings.
    • setRetentionGoalSettings

      public Goal.Builder setRetentionGoalSettings(GoalSetting.RetentionGoal value)
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
    • setRetentionGoalSettings

      public Goal.Builder setRetentionGoalSettings(GoalSetting.RetentionGoal.Builder builderForValue)
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
    • mergeRetentionGoalSettings

      public Goal.Builder mergeRetentionGoalSettings(GoalSetting.RetentionGoal value)
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
    • clearRetentionGoalSettings

      public Goal.Builder clearRetentionGoalSettings()
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
    • getRetentionGoalSettingsBuilder

      public GoalSetting.RetentionGoal.Builder getRetentionGoalSettingsBuilder()
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
    • getRetentionGoalSettingsOrBuilder

      public GoalSetting.RetentionGoalOrBuilder getRetentionGoalSettingsOrBuilder()
       Retention goal settings.
       
      .google.ads.googleads.v22.common.GoalSetting.RetentionGoal retention_goal_settings = 7;
      Specified by:
      getRetentionGoalSettingsOrBuilder in interface GoalOrBuilder
    • setUnknownFields

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

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