Class CreateCalculatedMetricRequest.Builder (0.95.0)

public static final class CreateCalculatedMetricRequest.Builder extends GeneratedMessage.Builder<CreateCalculatedMetricRequest.Builder> implements CreateCalculatedMetricRequestOrBuilder

Request message for CreateCalculatedMetric RPC.

Protobuf type google.analytics.admin.v1alpha.CreateCalculatedMetricRequest

Static Methods

getDescriptor()

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

Methods

build()

public CreateCalculatedMetricRequest build()
Returns
Type Description
CreateCalculatedMetricRequest

buildPartial()

public CreateCalculatedMetricRequest buildPartial()
Returns
Type Description
CreateCalculatedMetricRequest

clear()

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

clearCalculatedMetric()

public CreateCalculatedMetricRequest.Builder clearCalculatedMetric()

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateCalculatedMetricRequest.Builder

clearCalculatedMetricId()

public CreateCalculatedMetricRequest.Builder clearCalculatedMetricId()

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

string calculated_metric_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateCalculatedMetricRequest.Builder

This builder for chaining.

clearParent()

public CreateCalculatedMetricRequest.Builder clearParent()

Required. Format: properties/{property_id} Example: properties/1234

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreateCalculatedMetricRequest.Builder

This builder for chaining.

getCalculatedMetric()

public CalculatedMetric getCalculatedMetric()

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CalculatedMetric

The calculatedMetric.

getCalculatedMetricBuilder()

public CalculatedMetric.Builder getCalculatedMetricBuilder()

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CalculatedMetric.Builder

getCalculatedMetricId()

public String getCalculatedMetricId()

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

string calculated_metric_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The calculatedMetricId.

getCalculatedMetricIdBytes()

public ByteString getCalculatedMetricIdBytes()

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

string calculated_metric_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for calculatedMetricId.

getCalculatedMetricOrBuilder()

public CalculatedMetricOrBuilder getCalculatedMetricOrBuilder()

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CalculatedMetricOrBuilder

getDefaultInstanceForType()

public CreateCalculatedMetricRequest getDefaultInstanceForType()
Returns
Type Description
CreateCalculatedMetricRequest

getDescriptorForType()

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

getParent()

public String getParent()

Required. Format: properties/{property_id} Example: properties/1234

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Format: properties/{property_id} Example: properties/1234

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

hasCalculatedMetric()

public boolean hasCalculatedMetric()

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the calculatedMetric field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCalculatedMetric(CalculatedMetric value)

public CreateCalculatedMetricRequest.Builder mergeCalculatedMetric(CalculatedMetric value)

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CalculatedMetric
Returns
Type Description
CreateCalculatedMetricRequest.Builder

mergeFrom(CreateCalculatedMetricRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setCalculatedMetric(CalculatedMetric value)

public CreateCalculatedMetricRequest.Builder setCalculatedMetric(CalculatedMetric value)

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CalculatedMetric
Returns
Type Description
CreateCalculatedMetricRequest.Builder

setCalculatedMetric(CalculatedMetric.Builder builderForValue)

public CreateCalculatedMetricRequest.Builder setCalculatedMetric(CalculatedMetric.Builder builderForValue)

Required. The CalculatedMetric to create.

.google.analytics.admin.v1alpha.CalculatedMetric calculated_metric = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue CalculatedMetric.Builder
Returns
Type Description
CreateCalculatedMetricRequest.Builder

setCalculatedMetricId(String value)

public CreateCalculatedMetricRequest.Builder setCalculatedMetricId(String value)

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

string calculated_metric_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The calculatedMetricId to set.

Returns
Type Description
CreateCalculatedMetricRequest.Builder

This builder for chaining.

setCalculatedMetricIdBytes(ByteString value)

public CreateCalculatedMetricRequest.Builder setCalculatedMetricIdBytes(ByteString value)

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

string calculated_metric_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for calculatedMetricId to set.

Returns
Type Description
CreateCalculatedMetricRequest.Builder

This builder for chaining.

setParent(String value)

public CreateCalculatedMetricRequest.Builder setParent(String value)

Required. Format: properties/{property_id} Example: properties/1234

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateCalculatedMetricRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateCalculatedMetricRequest.Builder setParentBytes(ByteString value)

Required. Format: properties/{property_id} Example: properties/1234

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateCalculatedMetricRequest.Builder

This builder for chaining.