Package com.google.api

Class FieldPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.api.FieldPolicy
All Implemented Interfaces:
FieldPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class FieldPolicy extends com.google.protobuf.GeneratedMessageV3 implements FieldPolicyOrBuilder
 Google API Policy Annotation

 This message defines a simple API policy annotation that can be used to
 annotate API request and response message fields with applicable policies.
 One field may have multiple applicable policies that must all be satisfied
 before a request can be processed. This policy annotation is used to
 generate the overall policy that will be used for automatic runtime
 policy enforcement and documentation generation.
Protobuf type google.api.FieldPolicy
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FieldPolicy.Builder
    Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    RESOURCE_PERMISSION_FIELD_NUMBER
     
    static final int
    RESOURCE_TYPE_FIELD_NUMBER
     
    static final int
    SELECTOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static FieldPolicy
    getDefaultInstance()
     
    FieldPolicy
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<FieldPolicy>
    getParserForType()
     
    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.
    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.
    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`.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FieldPolicy.Builder
    newBuilder()
     
    static FieldPolicy.Builder
    newBuilder(FieldPolicy prototype)
     
    FieldPolicy.Builder
    newBuilderForType()
     
    protected FieldPolicy.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FieldPolicy
    parseDelimitedFrom(InputStream input)
     
    static FieldPolicy
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPolicy
    parseFrom(byte[] data)
     
    static FieldPolicy
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPolicy
    parseFrom(com.google.protobuf.ByteString data)
     
    static FieldPolicy
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPolicy
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FieldPolicy
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPolicy
    parseFrom(InputStream input)
     
    static FieldPolicy
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPolicy
    parseFrom(ByteBuffer data)
     
    static FieldPolicy
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FieldPolicy>
    parser()
     
    FieldPolicy.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • SELECTOR_FIELD_NUMBER

      public static final int SELECTOR_FIELD_NUMBER
      See Also:

    • RESOURCE_PERMISSION_FIELD_NUMBER

      public static final int RESOURCE_PERMISSION_FIELD_NUMBER
      See Also:

    • RESOURCE_TYPE_FIELD_NUMBER

      public static final int RESOURCE_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getSelector

      public 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;
      Specified by:
      getSelector in interface FieldPolicyOrBuilder
      Returns:
      The selector.

    • getSelectorBytes

      public 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;
      Specified by:
      getSelectorBytes in interface FieldPolicyOrBuilder
      Returns:
      The bytes for selector.

    • getResourcePermission

      public 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;
      Specified by:
      getResourcePermission in interface FieldPolicyOrBuilder
      Returns:
      The resourcePermission.

    • getResourcePermissionBytes

      public 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;
      Specified by:
      getResourcePermissionBytes in interface FieldPolicyOrBuilder
      Returns:
      The bytes for resourcePermission.

    • getResourceType

      public String getResourceType()
       Specifies the resource type for the resource referred to by the field.
      string resource_type = 3;
      Specified by:
      getResourceType in interface FieldPolicyOrBuilder
      Returns:
      The resourceType.

    • getResourceTypeBytes

      public com.google.protobuf.ByteString getResourceTypeBytes()
       Specifies the resource type for the resource referred to by the field.
      string resource_type = 3;
      Specified by:
      getResourceTypeBytes in interface FieldPolicyOrBuilder
      Returns:
      The bytes for resourceType.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static FieldPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FieldPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FieldPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FieldPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FieldPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FieldPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public FieldPolicy.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static FieldPolicy.Builder newBuilder()

    • newBuilder

      public static FieldPolicy.Builder newBuilder(FieldPolicy prototype)

    • toBuilder

      public FieldPolicy.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected FieldPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static FieldPolicy getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<FieldPolicy> parser()

    • getParserForType

      public com.google.protobuf.Parser<FieldPolicy> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public FieldPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder