// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/http.proto
package com.google.api;
public interface HttpRuleOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.api.HttpRule)
com.google.protobuf.MessageLiteOrBuilder {
/**
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
* @return The selector.
*/
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;
* @return The bytes for selector.
*/
com.google.protobuf.ByteString
getSelectorBytes();
/**
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
* @return The get.
*/
java.lang.String getGet();
/**
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
* @return The bytes for get.
*/
com.google.protobuf.ByteString
getGetBytes();
/**
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
* @return The put.
*/
java.lang.String getPut();
/**
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
* @return The bytes for put.
*/
com.google.protobuf.ByteString
getPutBytes();
/**
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
* @return The post.
*/
java.lang.String getPost();
/**
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
* @return The bytes for post.
*/
com.google.protobuf.ByteString
getPostBytes();
/**
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
* @return The delete.
*/
java.lang.String getDelete();
/**
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
* @return The bytes for delete.
*/
com.google.protobuf.ByteString
getDeleteBytes();
/**
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
* @return The patch.
*/
java.lang.String getPatch();
/**
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
* @return The bytes for patch.
*/
com.google.protobuf.ByteString
getPatchBytes();
/**
*
* 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;
* @return Whether the custom field is set.
*/
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;
* @return The custom.
*/
com.google.api.CustomHttpPattern getCustom();
/**
*
* 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;
* @return The body.
*/
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;
* @return The bytes for body.
*/
com.google.protobuf.ByteString
getBodyBytes();
/**
*
* 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;
* @return The responseBody.
*/
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;
* @return The bytes for responseBody.
*/
com.google.protobuf.ByteString
getResponseBodyBytes();
/**
*
* 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;
*/
java.util.List
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;
*/
com.google.api.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;
*/
int getAdditionalBindingsCount();
public com.google.api.HttpRule.PatternCase getPatternCase();
}