Class CreatePolicyRequest (1.24.0)

public final class CreatePolicyRequest extends GeneratedMessageV3 implements CreatePolicyRequestOrBuilder

Request message for CreatePolicy.

Protobuf type google.iam.v2.CreatePolicyRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

POLICY_FIELD_NUMBER

public static final int POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

POLICY_ID_FIELD_NUMBER

public static final int POLICY_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreatePolicyRequest getDefaultInstance()
Returns
TypeDescription
CreatePolicyRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreatePolicyRequest.Builder newBuilder()
Returns
TypeDescription
CreatePolicyRequest.Builder

newBuilder(CreatePolicyRequest prototype)

public static CreatePolicyRequest.Builder newBuilder(CreatePolicyRequest prototype)
Parameter
NameDescription
prototypeCreatePolicyRequest
Returns
TypeDescription
CreatePolicyRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreatePolicyRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreatePolicyRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreatePolicyRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreatePolicyRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreatePolicyRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreatePolicyRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreatePolicyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreatePolicyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreatePolicyRequest> parser()
Returns
TypeDescription
Parser<CreatePolicyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreatePolicyRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreatePolicyRequest> getParserForType()
Returns
TypeDescription
Parser<CreatePolicyRequest>
Overrides

getPolicy()

public Policy getPolicy()

Required. The policy to create.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
PolicyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasPolicy()

public boolean hasPolicy()

Required. The policy to create.

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

Returns
TypeDescription
boolean

Whether the policy field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreatePolicyRequest.Builder newBuilderForType()
Returns
TypeDescription
CreatePolicyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreatePolicyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreatePolicyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreatePolicyRequest.Builder toBuilder()
Returns
TypeDescription
CreatePolicyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException