Class ListPoliciesRequest.Builder (1.34.0)

public static final class ListPoliciesRequest.Builder extends GeneratedMessageV3.Builder<ListPoliciesRequest.Builder> implements ListPoliciesRequestOrBuilder

Request message for ListPolicies.

Protobuf type google.iam.v2.ListPoliciesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListPoliciesRequest build()
Returns
Type Description
ListPoliciesRequest

buildPartial()

public ListPoliciesRequest buildPartial()
Returns
Type Description
ListPoliciesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListPoliciesRequest.Builder clearPageSize()

The maximum number of policies to return. IAM ignores this value and uses the value 1000.

int32 page_size = 2;

Returns
Type Description
ListPoliciesRequest.Builder

This builder for chaining.

clearPageToken()

public ListPoliciesRequest.Builder clearPageToken()

A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

string page_token = 3;

Returns
Type Description
ListPoliciesRequest.Builder

This builder for chaining.

clearParent()

public ListPoliciesRequest.Builder clearParent()

Required. The resource that the policy is attached to, along with the kind of policy to list. 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
ListPoliciesRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListPoliciesRequest getDefaultInstanceForType()
Returns
Type Description
ListPoliciesRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

The maximum number of policies to return. IAM ignores this value and uses the value 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource that the policy is attached to, along with the kind of policy to list. 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 list. 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListPoliciesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListPoliciesRequest.Builder setPageSize(int value)

The maximum number of policies to return. IAM ignores this value and uses the value 1000.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListPoliciesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListPoliciesRequest.Builder setPageToken(String value)

A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListPoliciesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListPoliciesRequest.Builder setPageTokenBytes(ByteString value)

A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListPoliciesRequest.Builder

This builder for chaining.

setParent(String value)

public ListPoliciesRequest.Builder setParent(String value)

Required. The resource that the policy is attached to, along with the kind of policy to list. 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
ListPoliciesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListPoliciesRequest.Builder setParentBytes(ByteString value)

Required. The resource that the policy is attached to, along with the kind of policy to list. 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
ListPoliciesRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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