Interface FieldPolicyOrBuilder (2.40.0)

public interface FieldPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getResourcePermission()

public abstract String getResourcePermission()

Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".

string resource_permission = 2;

Returns
Type Description
String

The resourcePermission.

getResourcePermissionBytes()

public abstract ByteString getResourcePermissionBytes()

Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".

string resource_permission = 2;

Returns
Type Description
ByteString

The bytes for resourcePermission.

getResourceType()

public abstract String getResourceType()

Specifies the resource type for the resource referred to by the field.

string resource_type = 3;

Returns
Type Description
String

The resourceType.

getResourceTypeBytes()

public abstract ByteString getResourceTypeBytes()

Specifies the resource type for the resource referred to by the field.

string resource_type = 3;

Returns
Type Description
ByteString

The bytes for resourceType.

getSelector()

public abstract String getSelector()

Selects one or more request or response message fields to apply this FieldPolicy.

When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value.

When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".

string selector = 1;

Returns
Type Description
String

The selector.

getSelectorBytes()

public abstract ByteString getSelectorBytes()

Selects one or more request or response message fields to apply this FieldPolicy.

When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value.

When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".

string selector = 1;

Returns
Type Description
ByteString

The bytes for selector.