Package com.google.api

Interface DocumentationRuleOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DocumentationRule, DocumentationRule.Builder
    public interface DocumentationRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDeprecationDescription()
      Deprecation description of the selected element(s).
      com.google.protobuf.ByteString getDeprecationDescriptionBytes()
      Deprecation description of the selected element(s).
      String getDescription()
      Description of the selected proto element (e.g.
      com.google.protobuf.ByteString getDescriptionBytes()
      Description of the selected proto element (e.g.
      String getSelector()
      The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.
      com.google.protobuf.ByteString getSelectorBytes()
      The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.

      • 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

        String getSelector()
         The selector is a comma-separated list of patterns for any element such as
 a method, a field, an enum value. Each pattern is a qualified name of the
 element which may end in "*", indicating a wildcard. Wildcards are only
 allowed at the end and for a whole component of the qualified name,
 i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
 one or more components. To specify a default for all applicable elements,
 the whole pattern "*" is used.
        string selector = 1;
        Returns:
        The selector.

      • getSelectorBytes

        com.google.protobuf.ByteString getSelectorBytes()
         The selector is a comma-separated list of patterns for any element such as
 a method, a field, an enum value. Each pattern is a qualified name of the
 element which may end in "*", indicating a wildcard. Wildcards are only
 allowed at the end and for a whole component of the qualified name,
 i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
 one or more components. To specify a default for all applicable elements,
 the whole pattern "*" is used.
        string selector = 1;
        Returns:
        The bytes for selector.

      • getDescription

        String getDescription()
         Description of the selected proto element (e.g. a message, a method, a
 'service' definition, or a field). Defaults to leading & trailing comments
 taken from the proto source definition of the proto element.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Description of the selected proto element (e.g. a message, a method, a
 'service' definition, or a field). Defaults to leading & trailing comments
 taken from the proto source definition of the proto element.
        string description = 2;
        Returns:
        The bytes for description.

      • getDeprecationDescription

        String getDeprecationDescription()
         Deprecation description of the selected element(s). It can be provided if
 an element is marked as `deprecated`.
        string deprecation_description = 3;
        Returns:
        The deprecationDescription.

      • getDeprecationDescriptionBytes

        com.google.protobuf.ByteString getDeprecationDescriptionBytes()
         Deprecation description of the selected element(s). It can be provided if
 an element is marked as `deprecated`.
        string deprecation_description = 3;
        Returns:
        The bytes for deprecationDescription.