HttpRuleOrBuilder (java API)

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

HttpRule, HttpRule.Builder
```
public interface HttpRuleOrBuilder
extends MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HttpRule`	`getAdditionalBindings(int index)` Additional HTTP bindings for the selector.
`int`	`getAdditionalBindingsCount()` Additional HTTP bindings for the selector.
`java.util.List<HttpRule>`	`getAdditionalBindingsList()` Additional HTTP bindings for the selector.
`HttpRuleOrBuilder`	`getAdditionalBindingsOrBuilder(int index)` Additional HTTP bindings for the selector.
`java.util.List<? extends HttpRuleOrBuilder>`	`getAdditionalBindingsOrBuilderList()` Additional HTTP bindings for the selector.
`java.lang.String`	`getBody()` The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body.
`ByteString`	`getBodyBytes()` The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request 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.
`java.lang.String`	`getDelete()` Maps to HTTP DELETE.
`ByteString`	`getDeleteBytes()` Maps to HTTP DELETE.
`java.lang.String`	`getGet()` Maps to HTTP GET.
`ByteString`	`getGetBytes()` Maps to HTTP GET.
`java.lang.String`	`getPatch()` Maps to HTTP PATCH.
`ByteString`	`getPatchBytes()` Maps to HTTP PATCH.
`HttpRule.PatternCase`	`getPatternCase()`
`java.lang.String`	`getPost()` Maps to HTTP POST.
`ByteString`	`getPostBytes()` Maps to HTTP POST.
`java.lang.String`	`getPut()` Maps to HTTP PUT.
`ByteString`	`getPutBytes()` Maps to HTTP PUT.
`java.lang.String`	`getResponseBody()` Optional.
`ByteString`	`getResponseBodyBytes()` Optional.
`java.lang.String`	`getSelector()` Selects a method to which this rule applies.
`ByteString`	`getSelectorBytes()` Selects a method 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

java.lang.String getSelector()

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

string selector = 1;

getSelectorBytes

ByteString getSelectorBytes()

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

string selector = 1;

getGet

java.lang.String getGet()

 Maps to HTTP GET. Used for listing and getting information about
 resources.

string get = 2;

getGetBytes

ByteString getGetBytes()

 Maps to HTTP GET. Used for listing and getting information about
 resources.

string get = 2;

getPut

java.lang.String getPut()

 Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

getPutBytes

ByteString getPutBytes()

 Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

getPost

java.lang.String getPost()

 Maps to HTTP POST. Used for creating a resource or performing an action.

string post = 4;

getPostBytes

ByteString getPostBytes()

 Maps to HTTP POST. Used for creating a resource or performing an action.

string post = 4;

getDelete

java.lang.String getDelete()

 Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

getDeleteBytes

ByteString getDeleteBytes()

 Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

getPatch

java.lang.String getPatch()

 Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

getPatchBytes

ByteString getPatchBytes()

 Maps to HTTP PATCH. 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

java.lang.String getBody()

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

string body = 7;

getBodyBytes

ByteString getBodyBytes()

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

string body = 7;

getResponseBody

java.lang.String getResponseBody()

 Optional. The name of the response field whose value is mapped to the HTTP
 response body. When omitted, the entire response message will be used
 as the HTTP response body.
 NOTE: The referred field must be present at the top-level of the response
 message type.

string response_body = 12;

getResponseBodyBytes

ByteString getResponseBodyBytes()

 Optional. The name of the response field whose value is mapped to the HTTP
 response body. When omitted, the entire response message will be used
 as the HTTP response body.
 NOTE: The referred field must be present at the top-level of the response
 message type.

string response_body = 12;