Interface CreateEntitlementRequestOrBuilder (0.3.0)

public interface CreateEntitlementRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEntitlement()

public abstract Entitlement getEntitlement()

Required. The resource being created

.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Entitlement

The entitlement.

getEntitlementId()

public abstract String getEntitlementId()

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.

string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The entitlementId.

getEntitlementIdBytes()

public abstract ByteString getEntitlementIdBytes()

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.

string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for entitlementId.

getEntitlementOrBuilder()

public abstract EntitlementOrBuilder getEntitlementOrBuilder()

Required. The resource being created

.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntitlementOrBuilder

getParent()

public abstract String getParent()

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}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getRequestId()

public abstract String getRequestId()

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 commitments.

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

string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public abstract ByteString getRequestIdBytes()

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 commitments.

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

string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestId.

hasEntitlement()

public abstract boolean hasEntitlement()

Required. The resource being created

.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the entitlement field is set.