Workload Identity v1 API - Class ServiceProducerName (1.0.0-beta01) 

public sealed class ServiceProducerName : IResourceName, IEquatable<ServiceProducerName>

Reference documentation and code samples for the Workload Identity v1 API class ServiceProducerName.

Resource name for the ServiceProducer resource.

Inheritance

object > ServiceProducerName

Namespace

Google.Cloud.WorkloadIdentity.V1

Assembly

Google.Cloud.WorkloadIdentity.V1.dll

Constructors

ServiceProducerName(string, string, string)

public ServiceProducerName(string projectId, string locationId, string serviceProducerId)

Constructs a new instance of a ServiceProducerName class from the component parts of pattern projects/{project}/locations/{location}/serviceProducers/{service_producer}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

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

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

ServiceProducerId

public string ServiceProducerId { get; }

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

Property Value
Type Description
string

Type

public ServiceProducerName.ResourceNameType Type { get; }

The ServiceProducerName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServiceProducerNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string serviceProducerId)

Formats the IDs into the string representation of this ServiceProducerName with pattern projects/{project}/locations/{location}/serviceProducers/{service_producer}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ServiceProducerName with pattern projects/{project}/locations/{location}/serviceProducers/{service_producer}.

FormatFolderLocationServiceProducer(string, string, string)

public static string FormatFolderLocationServiceProducer(string folderId, string locationId, string serviceProducerId)

Formats the IDs into the string representation of this ServiceProducerName with pattern folders/{folder}/locations/{location}/serviceProducers/{service_producer}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ServiceProducerName with pattern folders/{folder}/locations/{location}/serviceProducers/{service_producer}.

FormatOrganizationLocationServiceProducer(string, string, string)

public static string FormatOrganizationLocationServiceProducer(string organizationId, string locationId, string serviceProducerId)

Formats the IDs into the string representation of this ServiceProducerName with pattern organizations/{organization}/locations/{location}/serviceProducers/{service_producer}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ServiceProducerName with pattern organizations/{organization}/locations/{location}/serviceProducers/{service_producer}.

FormatProjectLocationServiceProducer(string, string, string)

public static string FormatProjectLocationServiceProducer(string projectId, string locationId, string serviceProducerId)

Formats the IDs into the string representation of this ServiceProducerName with pattern projects/{project}/locations/{location}/serviceProducers/{service_producer}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ServiceProducerName with pattern projects/{project}/locations/{location}/serviceProducers/{service_producer}.

FromFolderLocationServiceProducer(string, string, string)

public static ServiceProducerName FromFolderLocationServiceProducer(string folderId, string locationId, string serviceProducerId)

Creates a ServiceProducerName with the pattern folders/{folder}/locations/{location}/serviceProducers/{service_producer}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.
Returns
Type Description
ServiceProducerName

A new instance of ServiceProducerName constructed from the provided ids.

FromOrganizationLocationServiceProducer(string, string, string)

public static ServiceProducerName FromOrganizationLocationServiceProducer(string organizationId, string locationId, string serviceProducerId)

Creates a ServiceProducerName with the pattern organizations/{organization}/locations/{location}/serviceProducers/{service_producer}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.
Returns
Type Description
ServiceProducerName

A new instance of ServiceProducerName constructed from the provided ids.

FromProjectLocationServiceProducer(string, string, string)

public static ServiceProducerName FromProjectLocationServiceProducer(string projectId, string locationId, string serviceProducerId)

Creates a ServiceProducerName with the pattern projects/{project}/locations/{location}/serviceProducers/{service_producer}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
serviceProducerId string

The ServiceProducer ID. Must not be null or empty.
Returns
Type Description
ServiceProducerName

A new instance of ServiceProducerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceProducerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceProducerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ServiceProducerName

A new instance of ServiceProducerName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ServiceProducerName Parse(string serviceProducerName)

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

Parameter
Name Description
serviceProducerName string

The resource name in string form. Must not be null.
Returns
Type Description
ServiceProducerName

The parsed ServiceProducerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/serviceProducers/{service_producer}
  • folders/{folder}/locations/{location}/serviceProducers/{service_producer}
  • organizations/{organization}/locations/{location}/serviceProducers/{service_producer}

Parse(string, bool)

public static ServiceProducerName Parse(string serviceProducerName, bool allowUnparsed)

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

Parameters
Name Description
serviceProducerName string

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

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
Type Description
ServiceProducerName

The parsed ServiceProducerName if successful.
Remarks

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

  • projects/{project}/locations/{location}/serviceProducers/{service_producer}
  • folders/{folder}/locations/{location}/serviceProducers/{service_producer}
  • organizations/{organization}/locations/{location}/serviceProducers/{service_producer}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out ServiceProducerName)

public static bool TryParse(string serviceProducerName, out ServiceProducerName result)

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

Parameters
Name Description
serviceProducerName string

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

When this method returns, the parsed ServiceProducerName, or null if parsing failed.
Returns
Type Description
bool

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}/locations/{location}/serviceProducers/{service_producer}
  • folders/{folder}/locations/{location}/serviceProducers/{service_producer}
  • organizations/{organization}/locations/{location}/serviceProducers/{service_producer}

TryParse(string, bool, out ServiceProducerName)

public static bool TryParse(string serviceProducerName, bool allowUnparsed, out ServiceProducerName result)

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

Parameters
Name Description
serviceProducerName string

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

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.
result ServiceProducerName

When this method returns, the parsed ServiceProducerName, or null if parsing failed.
Returns
Type Description
bool

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}/locations/{location}/serviceProducers/{service_producer}
  • folders/{folder}/locations/{location}/serviceProducers/{service_producer}
  • organizations/{organization}/locations/{location}/serviceProducers/{service_producer}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ServiceProducerName, ServiceProducerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServiceProducerName

The first resource name to compare, or null.
b ServiceProducerName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ServiceProducerName, ServiceProducerName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServiceProducerName

The first resource name to compare, or null.
b ServiceProducerName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.