Interface HttpRuleOrBuilder (2.30.0)

Version 2.30.0

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface HttpRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdditionalBindings(int index)

public abstract 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;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpRule

getAdditionalBindingsCount()

public abstract 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;

Returns
Type	Description
int

getAdditionalBindingsList()

public abstract 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;

Returns
Type	Description
List<HttpRule>

getAdditionalBindingsOrBuilder(int index)

public abstract 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;

Parameter
Name	Description
index	int

Returns
Type	Description
HttpRuleOrBuilder

getAdditionalBindingsOrBuilderList()

public abstract 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;

Returns
Type	Description
List<? extends com.google.api.HttpRuleOrBuilder>

getBody()

public abstract 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;

Returns
Type	Description
String	The body.

getBodyBytes()

public abstract 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;

Returns
Type	Description
ByteString	The bytes for body.

getCustom()

public abstract 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
Type	Description
CustomHttpPattern	The custom.

getCustomOrBuilder()

public abstract 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;

Returns
Type	Description
CustomHttpPatternOrBuilder

getDelete()

public abstract String getDelete()

Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

Returns
Type	Description
String	The delete.

getDeleteBytes()

public abstract ByteString getDeleteBytes()

Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

Returns
Type	Description
ByteString	The bytes for delete.

getGet()

public abstract String getGet()

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

string get = 2;

Returns
Type	Description
String	The get.

getGetBytes()

public abstract ByteString getGetBytes()

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

string get = 2;

Returns
Type	Description
ByteString	The bytes for get.

getPatch()

public abstract String getPatch()

Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

Returns
Type	Description
String	The patch.

getPatchBytes()

public abstract ByteString getPatchBytes()

Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

Returns
Type	Description
ByteString	The bytes for patch.

getPatternCase()

public abstract HttpRule.PatternCase getPatternCase()

Returns
Type	Description
HttpRule.PatternCase

getPost()

public abstract String getPost()

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

string post = 4;

Returns
Type	Description
String	The post.

getPostBytes()

public abstract ByteString getPostBytes()

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

string post = 4;

Returns
Type	Description
ByteString	The bytes for post.

getPut()

public abstract String getPut()

Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

Returns
Type	Description
String	The put.

getPutBytes()

public abstract ByteString getPutBytes()

Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

Returns
Type	Description
ByteString	The bytes for put.

getResponseBody()

public abstract 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;

Returns
Type	Description
String	The responseBody.

getResponseBodyBytes()

public abstract 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;

Returns
Type	Description
ByteString	The bytes for responseBody.

getSelector()

public abstract String getSelector()

Selects a method to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
String	The selector.

getSelectorBytes()

public abstract ByteString getSelectorBytes()

Selects a method to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
ByteString	The bytes for selector.

hasCustom()

public abstract 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
Type	Description
boolean	Whether the custom field is set.

hasDelete()

public abstract boolean hasDelete()

Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

Returns
Type	Description
boolean	Whether the delete field is set.

hasGet()

public abstract boolean hasGet()

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

string get = 2;

Returns
Type	Description
boolean	Whether the get field is set.

hasPatch()

public abstract boolean hasPatch()

Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

Returns
Type	Description
boolean	Whether the patch field is set.

hasPost()

public abstract boolean hasPost()

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

string post = 4;

Returns
Type	Description
boolean	Whether the post field is set.

hasPut()

public abstract boolean hasPut()

Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

Returns
Type	Description
boolean	Whether the put field is set.