Class CreatePolicyRequest.Builder (1.45.0)

public static final class CreatePolicyRequest.Builder extends GeneratedMessageV3.Builder<CreatePolicyRequest.Builder> implements CreatePolicyRequestOrBuilder

Request message for CreatePolicy.

Protobuf type google.iam.v2.CreatePolicyRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CreatePolicyRequest build()
Returns
Type Description
CreatePolicyRequest

buildPartial()

public CreatePolicyRequest buildPartial()
Returns
Type Description
CreatePolicyRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public CreatePolicyRequest.Builder clearParent()

Required. The resource that the policy is attached to, along with the kind of policy to create. Format: policies/{attachment_point}/denypolicies

The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies.

For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreatePolicyRequest.Builder

This builder for chaining.

clearPolicy()

public CreatePolicyRequest.Builder clearPolicy()

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreatePolicyRequest.Builder

clearPolicyId()

public CreatePolicyRequest.Builder clearPolicyId()

The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (-) and periods (.). The first character must be a lowercase letter.

string policy_id = 3;

Returns
Type Description
CreatePolicyRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CreatePolicyRequest getDefaultInstanceForType()
Returns
Type Description
CreatePolicyRequest

getDescriptorForType()

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

getParent()

public String getParent()

Required. The resource that the policy is attached to, along with the kind of policy to create. Format: policies/{attachment_point}/denypolicies

The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies.

For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource that the policy is attached to, along with the kind of policy to create. Format: policies/{attachment_point}/denypolicies

The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies.

For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getPolicy()

public Policy getPolicy()

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Policy

The policy.

getPolicyBuilder()

public Policy.Builder getPolicyBuilder()

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Policy.Builder

getPolicyId()

public String getPolicyId()

The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (-) and periods (.). The first character must be a lowercase letter.

string policy_id = 3;

Returns
Type Description
String

The policyId.

getPolicyIdBytes()

public ByteString getPolicyIdBytes()

The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (-) and periods (.). The first character must be a lowercase letter.

string policy_id = 3;

Returns
Type Description
ByteString

The bytes for policyId.

getPolicyOrBuilder()

public PolicyOrBuilder getPolicyOrBuilder()

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyOrBuilder

hasPolicy()

public boolean hasPolicy()

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the policy field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CreatePolicyRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePolicy(Policy value)

public CreatePolicyRequest.Builder mergePolicy(Policy value)

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Policy
Returns
Type Description
CreatePolicyRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public CreatePolicyRequest.Builder setParent(String value)

Required. The resource that the policy is attached to, along with the kind of policy to create. Format: policies/{attachment_point}/denypolicies

The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies.

For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreatePolicyRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreatePolicyRequest.Builder setParentBytes(ByteString value)

Required. The resource that the policy is attached to, along with the kind of policy to create. Format: policies/{attachment_point}/denypolicies

The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies.

For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreatePolicyRequest.Builder

This builder for chaining.

setPolicy(Policy value)

public CreatePolicyRequest.Builder setPolicy(Policy value)

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Policy
Returns
Type Description
CreatePolicyRequest.Builder

setPolicy(Policy.Builder builderForValue)

public CreatePolicyRequest.Builder setPolicy(Policy.Builder builderForValue)

Required. The policy to create.

.google.iam.v2.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Policy.Builder
Returns
Type Description
CreatePolicyRequest.Builder

setPolicyId(String value)

public CreatePolicyRequest.Builder setPolicyId(String value)

The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (-) and periods (.). The first character must be a lowercase letter.

string policy_id = 3;

Parameter
Name Description
value String

The policyId to set.

Returns
Type Description
CreatePolicyRequest.Builder

This builder for chaining.

setPolicyIdBytes(ByteString value)

public CreatePolicyRequest.Builder setPolicyIdBytes(ByteString value)

The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (-) and periods (.). The first character must be a lowercase letter.

string policy_id = 3;

Parameter
Name Description
value ByteString

The bytes for policyId to set.

Returns
Type Description
CreatePolicyRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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