Class SubpropertySyncConfig (0.77.0)

public final class SubpropertySyncConfig extends GeneratedMessageV3 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 Fields

APPLY_TO_PROPERTY_FIELD_NUMBER

public static final int APPLY_TO_PROPERTY_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_DIMENSION_AND_METRIC_SYNC_MODE_FIELD_NUMBER

public static final int CUSTOM_DIMENSION_AND_METRIC_SYNC_MODE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SubpropertySyncConfig getDefaultInstance()
Returns
Type Description
SubpropertySyncConfig

getDescriptor()

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

newBuilder()

public static SubpropertySyncConfig.Builder newBuilder()
Returns
Type Description
SubpropertySyncConfig.Builder

newBuilder(SubpropertySyncConfig prototype)

public static SubpropertySyncConfig.Builder newBuilder(SubpropertySyncConfig prototype)
Parameter
Name Description
prototype SubpropertySyncConfig
Returns
Type Description
SubpropertySyncConfig.Builder

parseDelimitedFrom(InputStream input)

public static SubpropertySyncConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SubpropertySyncConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SubpropertySyncConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SubpropertySyncConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SubpropertySyncConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SubpropertySyncConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SubpropertySyncConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SubpropertySyncConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SubpropertySyncConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SubpropertySyncConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SubpropertySyncConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SubpropertySyncConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SubpropertySyncConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SubpropertySyncConfig> parser()
Returns
Type Description
Parser<SubpropertySyncConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

getParserForType()

public Parser<SubpropertySyncConfig> getParserForType()
Returns
Type Description
Parser<SubpropertySyncConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SubpropertySyncConfig.Builder newBuilderForType()
Returns
Type Description
SubpropertySyncConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SubpropertySyncConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SubpropertySyncConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SubpropertySyncConfig.Builder toBuilder()
Returns
Type Description
SubpropertySyncConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException