Class WebDataStreamName

Resource name for the WebDataStream resource.

Inheritance

System.Object

WebDataStreamName

Implements

Google.Api.Gax.IResourceName

System.IEquatable<WebDataStreamName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class WebDataStreamName : IResourceName, IEquatable<WebDataStreamName>

Constructors

WebDataStreamName(String, String)

Constructs a new instance of a WebDataStreamName class from the component parts of pattern properties/{property}/webDataStreams/{web_data_stream}

Declaration

public WebDataStreamName(string propertyId, string webDataStreamId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.
System.String	webDataStreamId	The `WebDataStream` ID. Must not be `null` or empty.

Properties

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

Google.Api.Gax.IResourceName.IsKnownPattern

PropertyId

The Property ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string PropertyId { get; }

Property Value

Type	Description
System.String

Type

The WebDataStreamName.ResourceNameType of the contained resource name.

Declaration

public WebDataStreamName.ResourceNameType Type { get; }

Property Value

Type	Description
WebDataStreamName.ResourceNameType

UnparsedResource

The contained Google.Api.Gax.UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
Google.Api.Gax.UnparsedResourceName

WebDataStreamId

The WebDataStream ID. Will not be null, unless this instance contains an unparsed resource name.

Declaration

public string WebDataStreamId { get; }

Property Value

Type	Description
System.String

Methods

Format(String, String)

Formats the IDs into the string representation of this WebDataStreamName with pattern properties/{property}/webDataStreams/{web_data_stream}.

Declaration

public static string Format(string propertyId, string webDataStreamId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.
System.String	webDataStreamId	The `WebDataStream` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this WebDataStreamName with pattern `properties/{property}/webDataStreams/{web_data_stream}`.

FormatPropertyWebDataStream(String, String)

Formats the IDs into the string representation of this WebDataStreamName with pattern properties/{property}/webDataStreams/{web_data_stream}.

Declaration

public static string FormatPropertyWebDataStream(string propertyId, string webDataStreamId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.
System.String	webDataStreamId	The `WebDataStream` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this WebDataStreamName with pattern `properties/{property}/webDataStreams/{web_data_stream}`.

FromPropertyWebDataStream(String, String)

Creates a WebDataStreamName with the pattern properties/{property}/webDataStreams/{web_data_stream}.

Declaration

public static WebDataStreamName FromPropertyWebDataStream(string propertyId, string webDataStreamId)

Parameters

Type	Name	Description
System.String	propertyId	The `Property` ID. Must not be `null` or empty.
System.String	webDataStreamId	The `WebDataStream` ID. Must not be `null` or empty.

Returns

Type	Description
WebDataStreamName	A new instance of WebDataStreamName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a WebDataStreamName containing an unparsed resource name.

Declaration

public static WebDataStreamName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
Google.Api.Gax.UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be `null`.

Returns

Type	Description
WebDataStreamName	A new instance of WebDataStreamName containing the provided `unparsedResourceName`.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

Parses the given resource name string into a new WebDataStreamName instance.

Declaration

public static WebDataStreamName Parse(string webDataStreamName)

Parameters

Type	Name	Description
System.String	webDataStreamName	The resource name in string form. Must not be `null`.

Returns

Type	Description
WebDataStreamName	The parsed WebDataStreamName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

properties/{property}/webDataStreams/{web_data_stream}

Parse(String, Boolean)

Parses the given resource name string into a new WebDataStreamName instance; optionally allowing an unparseable resource name.

Declaration

public static WebDataStreamName Parse(string webDataStreamName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	webDataStreamName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
WebDataStreamName	The parsed WebDataStreamName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

properties/{property}/webDataStreams/{web_data_stream}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

Google.Api.Gax.IResourceName.ToString()

TryParse(String, out WebDataStreamName)

Tries to parse the given resource name string into a new WebDataStreamName instance.

Declaration

public static bool TryParse(string webDataStreamName, out WebDataStreamName result)

Parameters

Type	Name	Description
System.String	webDataStreamName	The resource name in string form. Must not be `null`.
WebDataStreamName	result	When this method returns, the parsed WebDataStreamName, or `null` if parsing failed.

Returns

Type	Description
System.Boolean	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

properties/{property}/webDataStreams/{web_data_stream}

TryParse(String, Boolean, out WebDataStreamName)

Tries to parse the given resource name string into a new WebDataStreamName instance; optionally allowing an unparseable resource name.

Declaration

public static bool TryParse(string webDataStreamName, bool allowUnparsed, out WebDataStreamName result)

Parameters

Type	Name	Description
System.String	webDataStreamName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
WebDataStreamName	result	When this method returns, the parsed WebDataStreamName, or `null` if parsing failed.

Returns

Type	Description
System.Boolean	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

properties/{property}/webDataStreams/{web_data_stream}

Or may be in any format if allowUnparsed is true.

Operators

Equality(WebDataStreamName, WebDataStreamName)

Declaration

public static bool operator ==(WebDataStreamName a, WebDataStreamName b)

Parameters

Type	Name	Description
WebDataStreamName	a
WebDataStreamName	b

Returns

Type	Description
System.Boolean

Inequality(WebDataStreamName, WebDataStreamName)

Declaration

public static bool operator !=(WebDataStreamName a, WebDataStreamName b)

Parameters

Type	Name	Description
WebDataStreamName	a
WebDataStreamName	b

Returns

Type	Description
System.Boolean