Class SubpropertySyncConfig.Builder (0.77.0)

public static final class SubpropertySyncConfig.Builder extends GeneratedMessageV3.Builder<SubpropertySyncConfig.Builder> implements SubpropertySyncConfigOrBuilder

Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty.

Protobuf type google.analytics.admin.v1alpha.SubpropertySyncConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SubpropertySyncConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

build()

public SubpropertySyncConfig build()
Returns
Type Description
SubpropertySyncConfig

buildPartial()

public SubpropertySyncConfig buildPartial()
Returns
Type Description
SubpropertySyncConfig

clear()

public SubpropertySyncConfig.Builder clear()
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

clearApplyToProperty()

public SubpropertySyncConfig.Builder clearApplyToProperty()

Output only. Immutable. Resource name of the Subproperty that these settings apply to.

string apply_to_property = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

clearCustomDimensionAndMetricSyncMode()

public SubpropertySyncConfig.Builder clearCustomDimensionAndMetricSyncMode()

Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty.

If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL.

If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.

.google.analytics.admin.v1alpha.SubpropertySyncConfig.SynchronizationMode custom_dimension_and_metric_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SubpropertySyncConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

clearName()

public SubpropertySyncConfig.Builder clearName()

Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SubpropertySyncConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

clone()

public SubpropertySyncConfig.Builder clone()
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

getApplyToProperty()

public String getApplyToProperty()

Output only. Immutable. Resource name of the Subproperty that these settings apply to.

string apply_to_property = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The applyToProperty.

getApplyToPropertyBytes()

public ByteString getApplyToPropertyBytes()

Output only. Immutable. Resource name of the Subproperty that these settings apply to.

string apply_to_property = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for applyToProperty.

getCustomDimensionAndMetricSyncMode()

public SubpropertySyncConfig.SynchronizationMode getCustomDimensionAndMetricSyncMode()

Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty.

If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL.

If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.

.google.analytics.admin.v1alpha.SubpropertySyncConfig.SynchronizationMode custom_dimension_and_metric_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SubpropertySyncConfig.SynchronizationMode

The customDimensionAndMetricSyncMode.

getCustomDimensionAndMetricSyncModeValue()

public int getCustomDimensionAndMetricSyncModeValue()

Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty.

If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL.

If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.

.google.analytics.admin.v1alpha.SubpropertySyncConfig.SynchronizationMode custom_dimension_and_metric_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for customDimensionAndMetricSyncMode.

getDefaultInstanceForType()

public SubpropertySyncConfig getDefaultInstanceForType()
Returns
Type Description
SubpropertySyncConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SubpropertySyncConfig other)

public SubpropertySyncConfig.Builder mergeFrom(SubpropertySyncConfig other)
Parameter
Name Description
other SubpropertySyncConfig
Returns
Type Description
SubpropertySyncConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SubpropertySyncConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SubpropertySyncConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SubpropertySyncConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

setApplyToProperty(String value)

public SubpropertySyncConfig.Builder setApplyToProperty(String value)

Output only. Immutable. Resource name of the Subproperty that these settings apply to.

string apply_to_property = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The applyToProperty to set.

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

setApplyToPropertyBytes(ByteString value)

public SubpropertySyncConfig.Builder setApplyToPropertyBytes(ByteString value)

Output only. Immutable. Resource name of the Subproperty that these settings apply to.

string apply_to_property = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for applyToProperty to set.

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

setCustomDimensionAndMetricSyncMode(SubpropertySyncConfig.SynchronizationMode value)

public SubpropertySyncConfig.Builder setCustomDimensionAndMetricSyncMode(SubpropertySyncConfig.SynchronizationMode value)

Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty.

If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL.

If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.

.google.analytics.admin.v1alpha.SubpropertySyncConfig.SynchronizationMode custom_dimension_and_metric_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value SubpropertySyncConfig.SynchronizationMode

The customDimensionAndMetricSyncMode to set.

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

setCustomDimensionAndMetricSyncModeValue(int value)

public SubpropertySyncConfig.Builder setCustomDimensionAndMetricSyncModeValue(int value)

Required. Specifies the Custom Dimension / Metric synchronization mode for the Subproperty.

If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the Subproperty so long as the synchronization mode is set to ALL.

If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty.

.google.analytics.admin.v1alpha.SubpropertySyncConfig.SynchronizationMode custom_dimension_and_metric_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for customDimensionAndMetricSyncMode to set.

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SubpropertySyncConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

setName(String value)

public SubpropertySyncConfig.Builder setName(String value)

Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SubpropertySyncConfig.Builder setNameBytes(ByteString value)

Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SubpropertySyncConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SubpropertySyncConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SubpropertySyncConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides