com.google.appengine.v1.UrlMapOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-appengine-admin-v1 Show documentation
Proto library for google-cloud-appengine-admin
There is a newer version: 2.54.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/appengine/v1/app_yaml.proto

// Protobuf Java Version: 3.25.4
package com.google.appengine.v1;

public interface UrlMapOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.appengine.v1.UrlMap)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * URL prefix. Uses regular expression syntax, which means regexp
   * special characters must be escaped, but should not contain groupings.
   * All URLs that begin with this prefix are handled by this handler, using the
   * portion of the URL after the prefix as part of the file path.
   * 
   *
   * string url_regex = 1;
   *
   * @return The urlRegex.
   */
  java.lang.String getUrlRegex();
  /**
   *
   *
   *    * URL prefix. Uses regular expression syntax, which means regexp
   * special characters must be escaped, but should not contain groupings.
   * All URLs that begin with this prefix are handled by this handler, using the
   * portion of the URL after the prefix as part of the file path.
   * 
   *
   * string url_regex = 1;
   *
   * @return The bytes for urlRegex.
   */
  com.google.protobuf.ByteString getUrlRegexBytes();

  /**
   *
   *
   *    * Returns the contents of a file, such as an image, as the response.
   * 
   *
   * .google.appengine.v1.StaticFilesHandler static_files = 2;
   *
   * @return Whether the staticFiles field is set.
   */
  boolean hasStaticFiles();
  /**
   *
   *
   *    * Returns the contents of a file, such as an image, as the response.
   * 
   *
   * .google.appengine.v1.StaticFilesHandler static_files = 2;
   *
   * @return The staticFiles.
   */
  com.google.appengine.v1.StaticFilesHandler getStaticFiles();
  /**
   *
   *
   *    * Returns the contents of a file, such as an image, as the response.
   * 
   *
   * .google.appengine.v1.StaticFilesHandler static_files = 2;
   */
  com.google.appengine.v1.StaticFilesHandlerOrBuilder getStaticFilesOrBuilder();

  /**
   *
   *
   *    * Executes a script to handle the requests that match this URL
   * pattern. Only the `auto` value is supported for Node.js in the
   * App Engine standard environment, for example `"script": "auto"`.
   * 
   *
   * .google.appengine.v1.ScriptHandler script = 3;
   *
   * @return Whether the script field is set.
   */
  boolean hasScript();
  /**
   *
   *
   *    * Executes a script to handle the requests that match this URL
   * pattern. Only the `auto` value is supported for Node.js in the
   * App Engine standard environment, for example `"script": "auto"`.
   * 
   *
   * .google.appengine.v1.ScriptHandler script = 3;
   *
   * @return The script.
   */
  com.google.appengine.v1.ScriptHandler getScript();
  /**
   *
   *
   *    * Executes a script to handle the requests that match this URL
   * pattern. Only the `auto` value is supported for Node.js in the
   * App Engine standard environment, for example `"script": "auto"`.
   * 
   *
   * .google.appengine.v1.ScriptHandler script = 3;
   */
  com.google.appengine.v1.ScriptHandlerOrBuilder getScriptOrBuilder();

  /**
   *
   *
   *    * Uses API Endpoints to handle requests.
   * 
   *
   * .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
   *
   * @return Whether the apiEndpoint field is set.
   */
  boolean hasApiEndpoint();
  /**
   *
   *
   *    * Uses API Endpoints to handle requests.
   * 
   *
   * .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
   *
   * @return The apiEndpoint.
   */
  com.google.appengine.v1.ApiEndpointHandler getApiEndpoint();
  /**
   *
   *
   *    * Uses API Endpoints to handle requests.
   * 
   *
   * .google.appengine.v1.ApiEndpointHandler api_endpoint = 4;
   */
  com.google.appengine.v1.ApiEndpointHandlerOrBuilder getApiEndpointOrBuilder();

  /**
   *
   *
   *    * Security (HTTPS) enforcement for this URL.
   * 
   *
   * .google.appengine.v1.SecurityLevel security_level = 5;
   *
   * @return The enum numeric value on the wire for securityLevel.
   */
  int getSecurityLevelValue();
  /**
   *
   *
   *    * Security (HTTPS) enforcement for this URL.
   * 
   *
   * .google.appengine.v1.SecurityLevel security_level = 5;
   *
   * @return The securityLevel.
   */
  com.google.appengine.v1.SecurityLevel getSecurityLevel();

  /**
   *
   *
   *    * Level of login required to access this resource. Not supported for Node.js
   * in the App Engine standard environment.
   * 
   *
   * .google.appengine.v1.LoginRequirement login = 6;
   *
   * @return The enum numeric value on the wire for login.
   */
  int getLoginValue();
  /**
   *
   *
   *    * Level of login required to access this resource. Not supported for Node.js
   * in the App Engine standard environment.
   * 
   *
   * .google.appengine.v1.LoginRequirement login = 6;
   *
   * @return The login.
   */
  com.google.appengine.v1.LoginRequirement getLogin();

  /**
   *
   *
   *    * Action to take when users access resources that require
   * authentication. Defaults to `redirect`.
   * 
   *
   * .google.appengine.v1.AuthFailAction auth_fail_action = 7;
   *
   * @return The enum numeric value on the wire for authFailAction.
   */
  int getAuthFailActionValue();
  /**
   *
   *
   *    * Action to take when users access resources that require
   * authentication. Defaults to `redirect`.
   * 
   *
   * .google.appengine.v1.AuthFailAction auth_fail_action = 7;
   *
   * @return The authFailAction.
   */
  com.google.appengine.v1.AuthFailAction getAuthFailAction();

  /**
   *
   *
   *    * `30x` code to use when performing redirects for the `secure` field.
   * Defaults to `302`.
   * 
   *
   * .google.appengine.v1.UrlMap.RedirectHttpResponseCode redirect_http_response_code = 8;
   * 
   *
   * @return The enum numeric value on the wire for redirectHttpResponseCode.
   */
  int getRedirectHttpResponseCodeValue();
  /**
   *
   *
   *    * `30x` code to use when performing redirects for the `secure` field.
   * Defaults to `302`.
   * 
   *
   * .google.appengine.v1.UrlMap.RedirectHttpResponseCode redirect_http_response_code = 8;
   * 
   *
   * @return The redirectHttpResponseCode.
   */
  com.google.appengine.v1.UrlMap.RedirectHttpResponseCode getRedirectHttpResponseCode();

  com.google.appengine.v1.UrlMap.HandlerTypeCase getHandlerTypeCase();
}