Class FulfillmentName (4.0.0)

public sealed class FulfillmentName : IResourceName, IEquatable<FulfillmentName>

Resource name for the Fulfillment resource.

Inheritance

Object > FulfillmentName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

FulfillmentName(String)

public FulfillmentName(string projectId)

Constructs a new instance of a FulfillmentName class from the component parts of pattern projects/{project}/agent/fulfillment

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

Type

public FulfillmentName.ResourceNameType Type { get; }

The FulfillmentName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
FulfillmentName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String)

public static string Format(string projectId)

Formats the IDs into the string representation of this FulfillmentName with pattern projects/{project}/agent/fulfillment.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this FulfillmentName with pattern projects/{project}/agent/fulfillment.

FormatProject(String)

public static string FormatProject(string projectId)

Formats the IDs into the string representation of this FulfillmentName with pattern projects/{project}/agent/fulfillment.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this FulfillmentName with pattern projects/{project}/agent/fulfillment.

FormatProjectLocation(String, String)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this FulfillmentName with pattern projects/{project}/locations/{location}/agent/fulfillment.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this FulfillmentName with pattern projects/{project}/locations/{location}/agent/fulfillment.

FromProject(String)

public static FulfillmentName FromProject(string projectId)

Creates a FulfillmentName with the pattern projects/{project}/agent/fulfillment.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
FulfillmentName

A new instance of FulfillmentName constructed from the provided ids.

FromProjectLocation(String, String)

public static FulfillmentName FromProjectLocation(string projectId, string locationId)

Creates a FulfillmentName with the pattern projects/{project}/locations/{location}/agent/fulfillment.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
FulfillmentName

A new instance of FulfillmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FulfillmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FulfillmentName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
FulfillmentName

A new instance of FulfillmentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static FulfillmentName Parse(string fulfillmentName)

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

Parameter
NameDescription
fulfillmentNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
FulfillmentName

The parsed FulfillmentName if successful.

Remarks

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

  • projects/{project}/agent/fulfillment
  • projects/{project}/locations/{location}/agent/fulfillment

Parse(String, Boolean)

public static FulfillmentName Parse(string fulfillmentName, bool allowUnparsed)

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

Parameters
NameDescription
fulfillmentNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
TypeDescription
FulfillmentName

The parsed FulfillmentName if successful.

Remarks

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

  • projects/{project}/agent/fulfillment
  • projects/{project}/locations/{location}/agent/fulfillment
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out FulfillmentName)

public static bool TryParse(string fulfillmentName, out FulfillmentName result)

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

Parameters
NameDescription
fulfillmentNameString

The resource name in string form. Must not be null.

resultFulfillmentName

When this method returns, the parsed FulfillmentName, or null if parsing failed.

Returns
TypeDescription
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:

  • projects/{project}/agent/fulfillment
  • projects/{project}/locations/{location}/agent/fulfillment

TryParse(String, Boolean, out FulfillmentName)

public static bool TryParse(string fulfillmentName, bool allowUnparsed, out FulfillmentName result)

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

Parameters
NameDescription
fulfillmentNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

resultFulfillmentName

When this method returns, the parsed FulfillmentName, or null if parsing failed.

Returns
TypeDescription
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:

  • projects/{project}/agent/fulfillment
  • projects/{project}/locations/{location}/agent/fulfillment
Or may be in any format if allowUnparsed is true.

Operators

Equality(FulfillmentName, FulfillmentName)

public static bool operator ==(FulfillmentName a, FulfillmentName b)
Parameters
NameDescription
aFulfillmentName
bFulfillmentName
Returns
TypeDescription
Boolean

Inequality(FulfillmentName, FulfillmentName)

public static bool operator !=(FulfillmentName a, FulfillmentName b)
Parameters
NameDescription
aFulfillmentName
bFulfillmentName
Returns
TypeDescription
Boolean