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

public sealed class ServiceAgentName : IResourceName, IEquatable<ServiceAgentName>

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

Resource name for the ServiceAgent resource.

Inheritance

object > ServiceAgentName

Namespace

Google.Cloud.WorkloadIdentity.V1

Assembly

Google.Cloud.WorkloadIdentity.V1.dll

Constructors

ServiceAgentName(string, string, string, string)

public ServiceAgentName(string projectId, string locationId, string serviceProducerId, string serviceAgentId)

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

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.
serviceAgentId string

The ServiceAgent 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

ServiceAgentId

public string ServiceAgentId { get; }

The ServiceAgent 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 ServiceAgentName.ResourceNameType Type { get; }

The ServiceAgentName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServiceAgentNameResourceNameType

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, string)

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

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

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.
serviceAgentId string

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

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

FormatFolderLocationServiceProducerServiceAgent(string, string, string, string)

public static string FormatFolderLocationServiceProducerServiceAgent(string folderId, string locationId, string serviceProducerId, string serviceAgentId)

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

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.
serviceAgentId string

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

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

FormatOrganizationLocationServiceProducerServiceAgent(string, string, string, string)

public static string FormatOrganizationLocationServiceProducerServiceAgent(string organizationId, string locationId, string serviceProducerId, string serviceAgentId)

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

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.
serviceAgentId string

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

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

FormatProjectLocationServiceProducerServiceAgent(string, string, string, string)

public static string FormatProjectLocationServiceProducerServiceAgent(string projectId, string locationId, string serviceProducerId, string serviceAgentId)

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

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.
serviceAgentId string

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

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

FromFolderLocationServiceProducerServiceAgent(string, string, string, string)

public static ServiceAgentName FromFolderLocationServiceProducerServiceAgent(string folderId, string locationId, string serviceProducerId, string serviceAgentId)

Creates a ServiceAgentName with the pattern folders/{folder}/locations/{location}/serviceProducers/{service_producer}/serviceAgents/{service_agent} .

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.
serviceAgentId string

The ServiceAgent ID. Must not be null or empty.
Returns
Type Description
ServiceAgentName

A new instance of ServiceAgentName constructed from the provided ids.

FromOrganizationLocationServiceProducerServiceAgent(string, string, string, string)

public static ServiceAgentName FromOrganizationLocationServiceProducerServiceAgent(string organizationId, string locationId, string serviceProducerId, string serviceAgentId)

Creates a ServiceAgentName with the pattern organizations/{organization}/locations/{location}/serviceProducers/{service_producer}/serviceAgents/{service_agent} .

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.
serviceAgentId string

The ServiceAgent ID. Must not be null or empty.
Returns
Type Description
ServiceAgentName

A new instance of ServiceAgentName constructed from the provided ids.

FromProjectLocationServiceProducerServiceAgent(string, string, string, string)

public static ServiceAgentName FromProjectLocationServiceProducerServiceAgent(string projectId, string locationId, string serviceProducerId, string serviceAgentId)

Creates a ServiceAgentName with the pattern projects/{project}/locations/{location}/serviceProducers/{service_producer}/serviceAgents/{service_agent} .

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.
serviceAgentId string

The ServiceAgent ID. Must not be null or empty.
Returns
Type Description
ServiceAgentName

A new instance of ServiceAgentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceAgentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceAgentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ServiceAgentName 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 ServiceAgentName Parse(string serviceAgentName)

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

Parameter
Name Description
serviceAgentName string

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

The parsed ServiceAgentName if successful.
Remarks

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

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

Parse(string, bool)

public static ServiceAgentName Parse(string serviceAgentName, bool allowUnparsed)

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

Parameters
Name Description
serviceAgentName 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
ServiceAgentName

The parsed ServiceAgentName if successful.
Remarks

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

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

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 ServiceAgentName)

public static bool TryParse(string serviceAgentName, out ServiceAgentName result)

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

Parameters
Name Description
serviceAgentName string

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

When this method returns, the parsed ServiceAgentName, 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}/serviceAgents/{service_agent}
  • folders/{folder}/locations/{location}/serviceProducers/{service_producer}/serviceAgents/{service_agent}
  • organizations/{organization}/locations/{location}/serviceProducers/{service_producer}/serviceAgents/{service_agent}

TryParse(string, bool, out ServiceAgentName)

public static bool TryParse(string serviceAgentName, bool allowUnparsed, out ServiceAgentName result)

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

Parameters
Name Description
serviceAgentName 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 ServiceAgentName

When this method returns, the parsed ServiceAgentName, 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}/serviceAgents/{service_agent}
  • folders/{folder}/locations/{location}/serviceProducers/{service_producer}/serviceAgents/{service_agent}
  • organizations/{organization}/locations/{location}/serviceProducers/{service_producer}/serviceAgents/{service_agent}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ServiceAgentName, ServiceAgentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServiceAgentName

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

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 !=(ServiceAgentName, ServiceAgentName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServiceAgentName

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

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.