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

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

getResponseBody()

Optional.

com.google.protobuf.ByteString

getResponseBodyBytes()

Optional.

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.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getSelector

String getSelector()

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

string selector = 1;

Returns:: The selector.

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;

Returns:: The bytes for selector.

getGet

String getGet()

 Used for listing and getting information about resources.

string get = 2;

Returns:: The get.

getGetBytes

com.google.protobuf.ByteString getGetBytes()
```
 Used for listing and getting information about resources.
 
```
string get = 2;
Returns:

The bytes for get.
getPut

String getPut()
```
 Used for updating a resource.
 
```
string put = 3;
Returns:

The put.
getPutBytes

com.google.protobuf.ByteString getPutBytes()
```
 Used for updating a resource.
 
```
string put = 3;
Returns:

The bytes for put.
getPost

String getPost()
```
 Used for creating a resource.
 
```
string post = 4;
Returns:

The post.
getPostBytes

com.google.protobuf.ByteString getPostBytes()
```
 Used for creating a resource.
 
```
string post = 4;
Returns:

The bytes for post.
getDelete

String getDelete()
```
 Used for deleting a resource.
 
```
string delete = 5;
Returns:

The delete.
getDeleteBytes

com.google.protobuf.ByteString getDeleteBytes()
```
 Used for deleting a resource.
 
```
string delete = 5;
Returns:

The bytes for delete.
getPatch

String getPatch()
```
 Used for updating a resource.
 
```
string patch = 6;
Returns:

The patch.
getPatchBytes

com.google.protobuf.ByteString getPatchBytes()
```
 Used for updating a resource.
 
```
string patch = 6;
Returns:

The bytes for patch.

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;

Returns:: Whether the custom field is set.

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;

Returns:: The custom.

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;

Returns:: The body.

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;

Returns:: The bytes for body.

getResponseBody

String getResponseBody()

 Optional. The name of the response field whose value is mapped to the HTTP
 body of response. Other response fields are ignored. When
 not set, the response message will be used as HTTP body of response.

string response_body = 12;

Returns:: The responseBody.

getResponseBodyBytes

com.google.protobuf.ByteString getResponseBodyBytes()

 Optional. The name of the response field whose value is mapped to the HTTP
 body of response. Other response fields are ignored. When
 not set, the response message will be used as HTTP body of response.

string response_body = 12;

Returns:: The bytes for responseBody.