Class CreateEntitlementRequest.Builder (0.8.0)

public static final class CreateEntitlementRequest.Builder extends GeneratedMessageV3.Builder<CreateEntitlementRequest.Builder> implements CreateEntitlementRequestOrBuilder

Message for creating an entitlement.

Protobuf type google.cloud.privilegedaccessmanager.v1.CreateEntitlementRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateEntitlementRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

build()

public CreateEntitlementRequest build()
Returns
Type Description
CreateEntitlementRequest

buildPartial()

public CreateEntitlementRequest buildPartial()
Returns
Type Description
CreateEntitlementRequest

clear()

public CreateEntitlementRequest.Builder clear()
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

clearEntitlement()

public CreateEntitlementRequest.Builder clearEntitlement()

Required. The resource being created

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

Returns
Type Description
CreateEntitlementRequest.Builder

clearEntitlementId()

public CreateEntitlementRequest.Builder clearEntitlementId()

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
CreateEntitlementRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateEntitlementRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateEntitlementRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

clearParent()

public CreateEntitlementRequest.Builder clearParent()

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
CreateEntitlementRequest.Builder

This builder for chaining.

clearRequestId()

public CreateEntitlementRequest.Builder clearRequestId()

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

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

Returns
Type Description
CreateEntitlementRequest.Builder

This builder for chaining.

clone()

public CreateEntitlementRequest.Builder clone()
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateEntitlementRequest getDefaultInstanceForType()
Returns
Type Description
CreateEntitlementRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEntitlement()

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

getEntitlementBuilder()

public Entitlement.Builder getEntitlementBuilder()

Required. The resource being created

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

Returns
Type Description
Entitlement.Builder

getEntitlementId()

public 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 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 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 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 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 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 entitlements.

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEntitlement(Entitlement value)

public CreateEntitlementRequest.Builder mergeEntitlement(Entitlement value)

Required. The resource being created

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

Parameter
Name Description
value Entitlement
Returns
Type Description
CreateEntitlementRequest.Builder

mergeFrom(CreateEntitlementRequest other)

public CreateEntitlementRequest.Builder mergeFrom(CreateEntitlementRequest other)
Parameter
Name Description
other CreateEntitlementRequest
Returns
Type Description
CreateEntitlementRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateEntitlementRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateEntitlementRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateEntitlementRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

setEntitlement(Entitlement value)

public CreateEntitlementRequest.Builder setEntitlement(Entitlement value)

Required. The resource being created

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

Parameter
Name Description
value Entitlement
Returns
Type Description
CreateEntitlementRequest.Builder

setEntitlement(Entitlement.Builder builderForValue)

public CreateEntitlementRequest.Builder setEntitlement(Entitlement.Builder builderForValue)

Required. The resource being created

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

Parameter
Name Description
builderForValue Entitlement.Builder
Returns
Type Description
CreateEntitlementRequest.Builder

setEntitlementId(String value)

public CreateEntitlementRequest.Builder setEntitlementId(String value)

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];

Parameter
Name Description
value String

The entitlementId to set.

Returns
Type Description
CreateEntitlementRequest.Builder

This builder for chaining.

setEntitlementIdBytes(ByteString value)

public CreateEntitlementRequest.Builder setEntitlementIdBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for entitlementId to set.

Returns
Type Description
CreateEntitlementRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateEntitlementRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

setParent(String value)

public CreateEntitlementRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateEntitlementRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateEntitlementRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateEntitlementRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateEntitlementRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides

setRequestId(String value)

public CreateEntitlementRequest.Builder setRequestId(String value)

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

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

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
CreateEntitlementRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CreateEntitlementRequest.Builder setRequestIdBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
CreateEntitlementRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateEntitlementRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateEntitlementRequest.Builder
Overrides