Google Cloud Datastore v1 API - Class ArrayValue (4.12.0)

public sealed class ArrayValue : IMessage<ArrayValue>, IEquatable<ArrayValue>, IDeepCloneable<ArrayValue>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Datastore v1 API class ArrayValue.

An array value.

Inheritance

object > ArrayValue

Namespace

Google.Cloud.Datastore.V1

Assembly

Google.Cloud.Datastore.V1.dll

Constructors

ArrayValue()

public ArrayValue()

ArrayValue(ArrayValue)

public ArrayValue(ArrayValue other)
Parameter
Name Description
other ArrayValue

Properties

Values

public RepeatedField<Value> Values { get; }

Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.

Property Value
Type Description
RepeatedFieldValue

Operators

explicit operator ArrayValue[](ArrayValue)

public static explicit operator ArrayValue[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
ArrayValue

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator Entity[](ArrayValue)

public static explicit operator Entity[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
Entity

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator Key[](ArrayValue)

public static explicit operator Key[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
Key

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator Value[](ArrayValue)

public static explicit operator Value[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
Value

An array with converted values, or null if arrayValue is null.

explicit operator ByteString[](ArrayValue)

public static explicit operator ByteString[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
ByteString

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator Timestamp[](ArrayValue)

public static explicit operator Timestamp[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
Timestamp

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator LatLng[](ArrayValue)

public static explicit operator LatLng[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
LatLng

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator bool[](ArrayValue)

public static explicit operator bool[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
bool

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator byte[][](ArrayValue)

public static explicit operator byte[][](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
byte

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator DateTimeOffset[](ArrayValue)

public static explicit operator DateTimeOffset[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
DateTimeOffset

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator DateTime[](ArrayValue)

public static explicit operator DateTime[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
DateTime

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator double[](ArrayValue)

public static explicit operator double[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
double

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator long[](ArrayValue)

public static explicit operator long[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
long

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator bool?[](ArrayValue)

public static explicit operator bool?[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
bool

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator DateTimeOffset?[](ArrayValue)

public static explicit operator DateTimeOffset?[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
DateTimeOffset

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator DateTime?[](ArrayValue)

public static explicit operator DateTime?[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
DateTime

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator double?[](ArrayValue)

public static explicit operator double?[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
double

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator long?[](ArrayValue)

public static explicit operator long?[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
long

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

explicit operator string[](ArrayValue)

public static explicit operator string[](ArrayValue arrayValue)

Converts an ArrayValue to an array. Each value within arrayValue is converted to a Value using the individual explicit conversion. Any Value elements with a kind of Null are converted to null values in the resulting array.

Parameter
Name Description
arrayValue ArrayValue

The array value to convert.

Returns
Type Description
string

An array with converted values, or null if arrayValue is null.

Exceptions
Type Description
InvalidOperationException

An element in the array value does not have the expected kind.

implicit operator ArrayValue(ArrayValue[])

public static implicit operator ArrayValue(ArrayValue[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values ArrayValue

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(Entity[])

public static implicit operator ArrayValue(Entity[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values Entity

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(Key[])

public static implicit operator ArrayValue(Key[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values Key

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(Value[])

public static implicit operator ArrayValue(Value[] values)

Converts an array to an ArrayValue instance. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values Value

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(ByteString[])

public static implicit operator ArrayValue(ByteString[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values ByteString

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(Timestamp[])

public static implicit operator ArrayValue(Timestamp[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values Timestamp

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(LatLng[])

public static implicit operator ArrayValue(LatLng[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values LatLng

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(bool[])

public static implicit operator ArrayValue(bool[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion.

Parameter
Name Description
values bool

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(byte[][])

public static implicit operator ArrayValue(byte[][] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values byte

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(DateTimeOffset[])

public static implicit operator ArrayValue(DateTimeOffset[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion.

Parameter
Name Description
values DateTimeOffset

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(DateTime[])

public static implicit operator ArrayValue(DateTime[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion.

Parameter
Name Description
values DateTime

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(double[])

public static implicit operator ArrayValue(double[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion.

Parameter
Name Description
values double

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(long[])

public static implicit operator ArrayValue(long[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion.

Parameter
Name Description
values long

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(bool?[])

public static implicit operator ArrayValue(bool?[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values bool

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(DateTimeOffset?[])

public static implicit operator ArrayValue(DateTimeOffset?[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values DateTimeOffset

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(DateTime?[])

public static implicit operator ArrayValue(DateTime?[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values DateTime

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(double?[])

public static implicit operator ArrayValue(double?[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values double

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(long?[])

public static implicit operator ArrayValue(long?[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values long

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.

implicit operator ArrayValue(string[])

public static implicit operator ArrayValue(string[] values)

Converts an array to an ArrayValue instance. Each value within values is converted to a Value using the individual implicit conversion. Any null input values are converted to instances of Value with a kind of Null.

Parameter
Name Description
values string

The array to convert.

Returns
Type Description
ArrayValue

An ArrayValue with converted values, or null if values is null.