Package com.google.api

Class FieldPolicy.Builder

  • All Implemented Interfaces:
    FieldPolicyOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    FieldPolicy
    public static final class FieldPolicy.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>
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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      FieldPolicy.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      FieldPolicy build()  
      FieldPolicy buildPartial()  
      FieldPolicy.Builder clear()  
      FieldPolicy.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      FieldPolicy.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      FieldPolicy.Builder clearResourcePermission()
      Specifies the required permission(s) for the resource referred to by the field.
      FieldPolicy.Builder clearResourceType()
      Specifies the resource type for the resource referred to by the field.
      FieldPolicy.Builder clearSelector()
      Selects one or more request or response message fields to apply this `FieldPolicy`.
      FieldPolicy.Builder clone()  
      FieldPolicy getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      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`.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      FieldPolicy.Builder mergeFrom​(FieldPolicy other)  
      FieldPolicy.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      FieldPolicy.Builder mergeFrom​(com.google.protobuf.Message other)  
      FieldPolicy.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      FieldPolicy.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      FieldPolicy.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      FieldPolicy.Builder setResourcePermission​(java.lang.String value)
      Specifies the required permission(s) for the resource referred to by the field.
      FieldPolicy.Builder setResourcePermissionBytes​(com.google.protobuf.ByteString value)
      Specifies the required permission(s) for the resource referred to by the field.
      FieldPolicy.Builder setResourceType​(java.lang.String value)
      Specifies the resource type for the resource referred to by the field.
      FieldPolicy.Builder setResourceTypeBytes​(com.google.protobuf.ByteString value)
      Specifies the resource type for the resource referred to by the field.
      FieldPolicy.Builder setSelector​(java.lang.String value)
      Selects one or more request or response message fields to apply this `FieldPolicy`.
      FieldPolicy.Builder setSelectorBytes​(com.google.protobuf.ByteString value)
      Selects one or more request or response message fields to apply this `FieldPolicy`.
      FieldPolicy.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getParentForChildren

      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder

        addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension

      • Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

        getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3

      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<FieldPolicy.Builder>

      • getDefaultInstanceForType

        public FieldPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public FieldPolicy.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>

      • clearField

        public FieldPolicy.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>

      • clearOneof

        public FieldPolicy.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>

      • setRepeatedField

        public FieldPolicy.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>

      • addRepeatedField

        public FieldPolicy.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>

      • mergeFrom

        public FieldPolicy.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldPolicy.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,​FieldPolicy.Builder>

      • mergeFrom

        public FieldPolicy.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldPolicy.Builder>
        Throws:
        java.io.IOException

      • getSelector

        public 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;
        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.

      • setSelector

        public FieldPolicy.Builder setSelector​(java.lang.String value)
         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;
        Parameters:
        value - The selector to set.
        Returns:
        This builder for chaining.

      • clearSelector

        public FieldPolicy.Builder clearSelector()
         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:
        This builder for chaining.

      • setSelectorBytes

        public FieldPolicy.Builder setSelectorBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for selector to set.
        Returns:
        This builder for chaining.

      • getResourcePermission

        public 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;
        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.

      • setResourcePermission

        public FieldPolicy.Builder setResourcePermission​(java.lang.String value)
         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;
        Parameters:
        value - The resourcePermission to set.
        Returns:
        This builder for chaining.

      • clearResourcePermission

        public FieldPolicy.Builder clearResourcePermission()
         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:
        This builder for chaining.

      • setResourcePermissionBytes

        public FieldPolicy.Builder setResourcePermissionBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for resourcePermission to set.
        Returns:
        This builder for chaining.

      • getResourceType

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

      • setResourceType

        public FieldPolicy.Builder setResourceType​(java.lang.String value)
         Specifies the resource type for the resource referred to by the field.
        string resource_type = 3;
        Parameters:
        value - The resourceType to set.
        Returns:
        This builder for chaining.

      • clearResourceType

        public FieldPolicy.Builder clearResourceType()
         Specifies the resource type for the resource referred to by the field.
        string resource_type = 3;
        Returns:
        This builder for chaining.

      • setResourceTypeBytes

        public FieldPolicy.Builder setResourceTypeBytes​(com.google.protobuf.ByteString value)
         Specifies the resource type for the resource referred to by the field.
        string resource_type = 3;
        Parameters:
        value - The bytes for resourceType to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final FieldPolicy.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>

      • mergeUnknownFields

        public final FieldPolicy.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FieldPolicy.Builder>