Class CreatePolicyRequest (1.36.0)

public final class CreatePolicyRequest extends GeneratedMessageV3 implements CreatePolicyRequestOrBuilder

Request message for CreatePolicy.

Protobuf type google.iam.v2beta.CreatePolicyRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
Type Description
int

POLICY_ID_FIELD_NUMBER

public static final int POLICY_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreatePolicyRequest getDefaultInstance()
Returns
Type Description
CreatePolicyRequest

getDescriptor()

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

newBuilder()

public static CreatePolicyRequest.Builder newBuilder()
Returns
Type Description
CreatePolicyRequest.Builder

newBuilder(CreatePolicyRequest prototype)

public static CreatePolicyRequest.Builder newBuilder(CreatePolicyRequest prototype)
Parameter
Name Description
prototype CreatePolicyRequest
Returns
Type Description
CreatePolicyRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreatePolicyRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreatePolicyRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreatePolicyRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreatePolicyRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreatePolicyRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreatePolicyRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreatePolicyRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreatePolicyRequest> parser()
Returns
Type Description
Parser<CreatePolicyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreatePolicyRequest getDefaultInstanceForType()
Returns
Type Description
CreatePolicyRequest

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.

getParserForType()

public Parser<CreatePolicyRequest> getParserForType()
Returns
Type Description
Parser<CreatePolicyRequest>
Overrides

getPolicy()

public Policy getPolicy()

Required. The policy to create.

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

Returns
Type Description
Policy

The policy.

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.v2beta.Policy policy = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPolicy()

public boolean hasPolicy()

Required. The policy to create.

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

Returns
Type Description
boolean

Whether the policy field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreatePolicyRequest.Builder newBuilderForType()
Returns
Type Description
CreatePolicyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreatePolicyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreatePolicyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreatePolicyRequest.Builder toBuilder()
Returns
Type Description
CreatePolicyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException