Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.ApisResource

The "apis" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.ApisResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Apigateway.v1
Assembly: Google.Apis.Apigateway.v1.dll
Syntax
public class ProjectsResource.LocationsResource.ApisResource

Constructors

ApisResource(IClientService)

Constructs a new resource.

Declaration
public ApisResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Configs

Gets the Configs resource.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.ConfigsResource Configs { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.ApisResource.ConfigsResource

Methods

Create(ApigatewayApi, string)

Creates a new Api in a given project and location.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.CreateRequest Create(ApigatewayApi body, string parent)
Parameters
Type Name Description
ApigatewayApi body

The body of the request.

string parent

Required. Parent resource of the API, of the form: projects/*/locations/global

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.CreateRequest

Delete(string)

Deletes a single Api.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Resource name of the form: projects/*/locations/global/apis/*

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.DeleteRequest

Get(string)

Gets details of a single Api.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Resource name of the form: projects/*/locations/global/apis/*

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.GetIamPolicyRequest

List(string)

Lists Apis in a given project and location.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Parent resource of the API, of the form: projects/*/locations/global

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.ListRequest

Patch(ApigatewayApi, string)

Updates the parameters of a single Api.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.PatchRequest Patch(ApigatewayApi body, string name)
Parameters
Type Name Description
ApigatewayApi body

The body of the request.

string name

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.PatchRequest

SetIamPolicy(ApigatewaySetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.SetIamPolicyRequest SetIamPolicy(ApigatewaySetIamPolicyRequest body, string resource)
Parameters
Type Name Description
ApigatewaySetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.SetIamPolicyRequest

TestIamPermissions(ApigatewayTestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration
public virtual ProjectsResource.LocationsResource.ApisResource.TestIamPermissionsRequest TestIamPermissions(ApigatewayTestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
ApigatewayTestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.ApisResource.TestIamPermissionsRequest
In this article
Back to top Generated by DocFX