程序包 com.google.api

接口 HttpRuleOrBuilder

所有超级接口:

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

所有已知实现类:

HttpRule, HttpRule.Builder

public interface HttpRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

方法概要

修饰符和类型	方法	说明
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.
boolean	hasDelete()	Used for deleting a resource.
boolean	hasGet()	Used for listing and getting information about resources.
boolean	hasPatch()	Used for updating a resource.
boolean	hasPost()	Used for creating a resource.
boolean	hasPut()	Used for updating a resource.

从接口继承的方法 com.google.protobuf.MessageLiteOrBuilder

isInitialized

从接口继承的方法 com.google.protobuf.MessageOrBuilder

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

方法详细资料

getSelector

String getSelector()

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

string selector = 1;

返回:

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;

返回:

The bytes for selector.

hasGet

boolean hasGet()

 Used for listing and getting information about resources.
 

string get = 2;

返回:

Whether the get field is set.

getGet

String getGet()

 Used for listing and getting information about resources.
 

string get = 2;

返回:

The get.

getGetBytes

com.google.protobuf.ByteString getGetBytes()

 Used for listing and getting information about resources.
 

string get = 2;

返回:

The bytes for get.

hasPut

boolean hasPut()

 Used for updating a resource.
 

string put = 3;

返回:

Whether the put field is set.

getPut

String getPut()

 Used for updating a resource.
 

string put = 3;

返回:

The put.

getPutBytes

com.google.protobuf.ByteString getPutBytes()

 Used for updating a resource.
 

string put = 3;

返回:

The bytes for put.

hasPost

boolean hasPost()

 Used for creating a resource.
 

string post = 4;

返回:

Whether the post field is set.

getPost

String getPost()

 Used for creating a resource.
 

string post = 4;

返回:

The post.

getPostBytes

com.google.protobuf.ByteString getPostBytes()

 Used for creating a resource.
 

string post = 4;

返回:

The bytes for post.

hasDelete

boolean hasDelete()

 Used for deleting a resource.
 

string delete = 5;

返回:

Whether the delete field is set.

getDelete

String getDelete()

 Used for deleting a resource.
 

string delete = 5;

返回:

The delete.

getDeleteBytes

com.google.protobuf.ByteString getDeleteBytes()

 Used for deleting a resource.
 

string delete = 5;

返回:

The bytes for delete.

hasPatch

boolean hasPatch()

 Used for updating a resource.
 

string patch = 6;

返回:

Whether the patch field is set.

getPatch

String getPatch()

 Used for updating a resource.
 

string patch = 6;

返回:

The patch.

getPatchBytes

com.google.protobuf.ByteString getPatchBytes()

 Used for updating a resource.
 

string patch = 6;

返回:

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;

返回:

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;

返回:

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;

返回:

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;

返回:

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;

返回:

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;

返回:

The bytes for responseBody.

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()