com.google.api

Interface HttpRuleOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

HttpRule, HttpRule.Builder

public interface HttpRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
HttpRule	getAdditionalBindings(int index) Additional HTTP bindings for the selector.
int	getAdditionalBindingsCount() Additional HTTP bindings for the selector.
List<HttpRule>	getAdditionalBindingsList() Additional HTTP bindings for the selector.
HttpRuleOrBuilder	getAdditionalBindingsOrBuilder(int index) Additional HTTP bindings for the selector.
List<? extends HttpRuleOrBuilder>	getAdditionalBindingsOrBuilderList() Additional HTTP bindings for the selector.
String	getBody() The name of the request field whose value is mapped to the HTTP body, or `*` for mapping all fields not captured by the path pattern to the HTTP body.
com.google.protobuf.ByteString	getBodyBytes() The name of the request field whose value is mapped to the HTTP body, or `*` for mapping all fields not captured by the path pattern to the HTTP body.
CustomHttpPattern	getCustom() The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.
CustomHttpPatternOrBuilder	getCustomOrBuilder() The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.
String	getDelete() Used for deleting a resource.
com.google.protobuf.ByteString	getDeleteBytes() Used for deleting a resource.
String	getGet() Used for listing and getting information about resources.
com.google.protobuf.ByteString	getGetBytes() Used for listing and getting information about resources.
String	getPatch() Used for updating a resource.
com.google.protobuf.ByteString	getPatchBytes() Used for updating a resource.
HttpRule.PatternCase	getPatternCase()
String	getPost() Used for creating a resource.
com.google.protobuf.ByteString	getPostBytes() Used for creating a resource.
String	getPut() Used for updating a resource.
com.google.protobuf.ByteString	getPutBytes() Used for updating a resource.
String	getSelector() Selects methods to which this rule applies.
com.google.protobuf.ByteString	getSelectorBytes() Selects methods to which this rule applies.
boolean	hasCustom() The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSelector

String getSelector()

 Selects methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
 

string selector = 1;

getSelectorBytes

com.google.protobuf.ByteString getSelectorBytes()

 Selects methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
 

string selector = 1;

getGet

String getGet()

 Used for listing and getting information about resources.
 

string get = 2;

getGetBytes

com.google.protobuf.ByteString getGetBytes()

 Used for listing and getting information about resources.
 

string get = 2;

getPut

String getPut()

 Used for updating a resource.
 

string put = 3;

getPutBytes

com.google.protobuf.ByteString getPutBytes()

 Used for updating a resource.
 

string put = 3;

getPost

String getPost()

 Used for creating a resource.
 

string post = 4;

getPostBytes

com.google.protobuf.ByteString getPostBytes()

 Used for creating a resource.
 

string post = 4;

getDelete

String getDelete()

 Used for deleting a resource.
 

string delete = 5;

getDeleteBytes

com.google.protobuf.ByteString getDeleteBytes()

 Used for deleting a resource.
 

string delete = 5;

getPatch

String getPatch()

 Used for updating a resource.
 

string patch = 6;

getPatchBytes

com.google.protobuf.ByteString getPatchBytes()

 Used for updating a resource.
 

string patch = 6;

hasCustom

boolean hasCustom()

 The custom pattern is used for specifying an HTTP method that is not
 included in the `pattern` field, such as HEAD, or "*" to leave the
 HTTP method unspecified for this rule. The wild-card rule is useful
 for services that provide content to Web (HTML) clients.
 

.google.api.CustomHttpPattern custom = 8;

getCustom

CustomHttpPattern getCustom()

 The custom pattern is used for specifying an HTTP method that is not
 included in the `pattern` field, such as HEAD, or "*" to leave the
 HTTP method unspecified for this rule. The wild-card rule is useful
 for services that provide content to Web (HTML) clients.
 

.google.api.CustomHttpPattern custom = 8;

getCustomOrBuilder

CustomHttpPatternOrBuilder getCustomOrBuilder()

 The custom pattern is used for specifying an HTTP method that is not
 included in the `pattern` field, such as HEAD, or "*" to leave the
 HTTP method unspecified for this rule. The wild-card rule is useful
 for services that provide content to Web (HTML) clients.
 

.google.api.CustomHttpPattern custom = 8;

getBody

String getBody()

 The name of the request field whose value is mapped to the HTTP body, or
 `*` for mapping all fields not captured by the path pattern to the HTTP
 body. NOTE: the referred field must not be a repeated field and must be
 present at the top-level of request message type.
 

string body = 7;

getBodyBytes

com.google.protobuf.ByteString getBodyBytes()

 The name of the request field whose value is mapped to the HTTP body, or
 `*` for mapping all fields not captured by the path pattern to the HTTP
 body. NOTE: the referred field must not be a repeated field and must be
 present at the top-level of request message type.
 

string body = 7;

getAdditionalBindingsList

List<HttpRule> getAdditionalBindingsList()

 Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
 

repeated .google.api.HttpRule additional_bindings = 11;

getAdditionalBindings

HttpRule getAdditionalBindings(int index)

 Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
 

repeated .google.api.HttpRule additional_bindings = 11;

getAdditionalBindingsCount

int getAdditionalBindingsCount()

 Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
 

repeated .google.api.HttpRule additional_bindings = 11;

getAdditionalBindingsOrBuilderList

List<? extends HttpRuleOrBuilder> getAdditionalBindingsOrBuilderList()

 Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
 

repeated .google.api.HttpRule additional_bindings = 11;

getAdditionalBindingsOrBuilder

HttpRuleOrBuilder getAdditionalBindingsOrBuilder(int index)

 Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
 

repeated .google.api.HttpRule additional_bindings = 11;

getPatternCase

HttpRule.PatternCase getPatternCase()