Package com.google.api

Interface FieldPolicyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

FieldPolicy, FieldPolicy.Builder

public interface FieldPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
java.lang.String	getResourcePermission()	Specifies the required permission(s) for the resource referred to by the field.
com.google.protobuf.ByteString	getResourcePermissionBytes()	Specifies the required permission(s) for the resource referred to by the field.
java.lang.String	getResourceType()	Specifies the resource type for the resource referred to by the field.
com.google.protobuf.ByteString	getResourceTypeBytes()	Specifies the resource type for the resource referred to by the field.
java.lang.String	getSelector()	Selects one or more request or response message fields to apply this `FieldPolicy`.
com.google.protobuf.ByteString	getSelectorBytes()	Selects one or more request or response message fields to apply this `FieldPolicy`.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getSelector

java.lang.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:

The selector.

getSelectorBytes

com.google.protobuf.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:

The bytes for selector.

getResourcePermission

java.lang.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:

The resourcePermission.

getResourcePermissionBytes

com.google.protobuf.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:

The bytes for resourcePermission.

getResourceType

java.lang.String getResourceType()

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

string resource_type = 3;

Returns:

The resourceType.

getResourceTypeBytes

com.google.protobuf.ByteString getResourceTypeBytes()

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

string resource_type = 3;

Returns:

The bytes for resourceType.