Class CreateAccessPolicyRequest (1.67.0)

public final class CreateAccessPolicyRequest extends GeneratedMessage implements CreateAccessPolicyRequestOrBuilder

Request message for CreateAccessPolicy method.

Protobuf type google.iam.v3beta.CreateAccessPolicyRequest

Static Fields

ACCESS_POLICY_FIELD_NUMBER

public static final int ACCESS_POLICY_FIELD_NUMBER
Field Value
Type Description
int

ACCESS_POLICY_ID_FIELD_NUMBER

public static final int ACCESS_POLICY_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateAccessPolicyRequest getDefaultInstance()
Returns
Type Description
CreateAccessPolicyRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateAccessPolicyRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAccessPolicy()

public AccessPolicy getAccessPolicy()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AccessPolicy

The accessPolicy.

getAccessPolicyId()

public String getAccessPolicyId()

Required. The ID to use for the access policy, which will become the final component of the access policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

This value must be unique among all access policies with the same parent.

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

Returns
Type Description
String

The accessPolicyId.

getAccessPolicyIdBytes()

public ByteString getAccessPolicyIdBytes()

Required. The ID to use for the access policy, which will become the final component of the access policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

This value must be unique among all access policies with the same parent.

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

Returns
Type Description
ByteString

The bytes for accessPolicyId.

getAccessPolicyOrBuilder()

public AccessPolicyOrBuilder getAccessPolicyOrBuilder()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AccessPolicyOrBuilder

getDefaultInstanceForType()

public CreateAccessPolicyRequest getDefaultInstanceForType()
Returns
Type Description
CreateAccessPolicyRequest

getParent()

public String getParent()

Required. The parent resource where this access policy will be created.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource where this access policy will be created.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValidateOnly()

public boolean getValidateOnly()

Optional. If set, validate the request and preview the creation, but do not actually post it.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasAccessPolicy()

public boolean hasAccessPolicy()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the accessPolicy field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CreateAccessPolicyRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateAccessPolicyRequest.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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