Privileged Access Manager v1 API - Class CreateEntitlementRequest (1.0.0)

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

Reference documentation and code samples for the Privileged Access Manager v1 API class CreateEntitlementRequest.

Message for creating an entitlement.

Inheritance

object > CreateEntitlementRequest

Namespace

Google.Cloud.PrivilegedAccessManager.V1

Assembly

Google.Cloud.PrivilegedAccessManager.V1.dll

Constructors

CreateEntitlementRequest()

public CreateEntitlementRequest()

CreateEntitlementRequest(CreateEntitlementRequest)

public CreateEntitlementRequest(CreateEntitlementRequest other)
Parameter
Name Description
other CreateEntitlementRequest

Properties

Entitlement

public Entitlement Entitlement { get; set; }

Required. The resource being created

Property Value
Type Description
Entitlement

EntitlementId

public string EntitlementId { get; set; }

Required. The ID to use for this entitlement. This becomes the last part of the resource name.

This value should be 4-63 characters in length, and valid characters are "[a-z]", "[0-9]", and "-". The first character should be from [a-z].

This value should be unique among all other entitlements under the specified parent.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. Name of the parent resource for the entitlement. Possible formats:

  • organizations/{organization-number}/locations/{region}
  • folders/{folder-number}/locations/{region}
  • projects/{project-id|project-number}/locations/{region}
Property Value
Type Description
string

ParentAsFolderLocationName

public FolderLocationName ParentAsFolderLocationName { get; set; }

FolderLocationName-typed view over the Parent resource name property.

Property Value
Type Description
FolderLocationName

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

ParentAsOrganizationLocationName

public OrganizationLocationName ParentAsOrganizationLocationName { get; set; }

OrganizationLocationName-typed view over the Parent resource name property.

Property Value
Type Description
OrganizationLocationName

ParentAsResourceName

public IResourceName ParentAsResourceName { get; set; }

IResourceName-typed view over the Parent resource name property.

Property Value
Type Description
IResourceName

RequestId

public string RequestId { get; set; }

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees this for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request and returns the previous operation's response. This prevents clients from accidentally creating duplicate entitlements.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Property Value
Type Description
string