// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/http.proto
// Protobuf Java Version: 3.25.3
package com.google.api;
public interface HttpRuleOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.api.HttpRule)
com.google.protobuf.MessageOrBuilder {
/**
*
* Selects methods 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 methods 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();
/**
*
* Used for listing and getting information about resources.
*
*
* string get = 2;
* @return Whether the get field is set.
*/
boolean hasGet();
/**
*
* Used for listing and getting information about resources.
*
*
* string get = 2;
* @return The get.
*/
java.lang.String getGet();
/**
*
* Used for listing and getting information about resources.
*
*
* string get = 2;
* @return The bytes for get.
*/
com.google.protobuf.ByteString
getGetBytes();
/**
*
* Used for updating a resource.
*
*
* string put = 3;
* @return Whether the put field is set.
*/
boolean hasPut();
/**
*
* Used for updating a resource.
*
*
* string put = 3;
* @return The put.
*/
java.lang.String getPut();
/**
*
* Used for updating a resource.
*
*
* string put = 3;
* @return The bytes for put.
*/
com.google.protobuf.ByteString
getPutBytes();
/**
*
* Used for creating a resource.
*
*
* string post = 4;
* @return Whether the post field is set.
*/
boolean hasPost();
/**
*
* Used for creating a resource.
*
*
* string post = 4;
* @return The post.
*/
java.lang.String getPost();
/**
*
* Used for creating a resource.
*
*
* string post = 4;
* @return The bytes for post.
*/
com.google.protobuf.ByteString
getPostBytes();
/**
*
* Used for deleting a resource.
*
*
* string delete = 5;
* @return Whether the delete field is set.
*/
boolean hasDelete();
/**
*
* Used for deleting a resource.
*
*
* string delete = 5;
* @return The delete.
*/
java.lang.String getDelete();
/**
*
* Used for deleting a resource.
*
*
* string delete = 5;
* @return The bytes for delete.
*/
com.google.protobuf.ByteString
getDeleteBytes();
/**
*
* Used for updating a resource.
*
*
* string patch = 6;
* @return Whether the patch field is set.
*/
boolean hasPatch();
/**
*
* Used for updating a resource.
*
*
* string patch = 6;
* @return The patch.
*/
java.lang.String getPatch();
/**
*
* 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 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;
*/
com.google.api.CustomHttpPatternOrBuilder getCustomOrBuilder();
/**
*
* 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;
* @return The body.
*/
java.lang.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;
* @return The bytes for body.
*/
com.google.protobuf.ByteString
getBodyBytes();
/**
*
* 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;
* @return The responseBody.
*/
java.lang.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;
* @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();
/**
*
* 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
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;
*/
com.google.api.HttpRuleOrBuilder getAdditionalBindingsOrBuilder(
int index);
com.google.api.HttpRule.PatternCase getPatternCase();
}
