Class ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource

The "specs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ApigeeRegistry.v1

Assembly: Google.Apis.ApigeeRegistry.v1.dll

Syntax

public class ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource

Constructors

SpecsResource(IClientService)

Constructs a new resource.

Declaration

public SpecsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Artifacts

Gets the Artifacts resource.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ArtifactsResource Artifacts { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ArtifactsResource

Methods

Create(ApiSpec, string)

Creates a specified spec.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.CreateRequest Create(ApiSpec body, string parent)

Parameters

Type	Name	Description
ApiSpec	body	The body of the request.
string	parent	Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.CreateRequest

Delete(string)

Removes a specified spec, all revisions, and all child resources (e.g., artifacts).

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the spec to delete. Format: projects/*/locations/*/apis/*/versions/*/specs/*

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.DeleteRequest

DeleteRevision(string)

Deletes a revision of a spec.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.DeleteRevisionRequest DeleteRevision(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.DeleteRevisionRequest

Get(string)

Returns a specified spec.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the spec to retrieve. Format: projects/*/locations/*/apis/*/versions/*/specs/*

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetRequest

GetContents(string)

Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetContentsRequest GetContents(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the spec whose contents should be retrieved. Format: projects/*/locations/*/apis/*/versions/*/specs/*

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.GetContentsRequest

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.VersionsResource.SpecsResource.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.VersionsResource.SpecsResource.GetIamPolicyRequest

List(string)

Returns matching specs.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent, which owns this collection of specs. Format: projects/*/locations/*/apis/*/versions/*

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ListRequest

ListRevisions(string)

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ListRevisionsRequest ListRevisions(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the spec to list revisions for.

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.ListRevisionsRequest

Patch(ApiSpec, string)

Used to modify a specified spec.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.PatchRequest Patch(ApiSpec body, string name)

Parameters

Type	Name	Description
ApiSpec	body	The body of the request.
string	name	Resource name.

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.PatchRequest

Rollback(RollbackApiSpecRequest, string)

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.RollbackRequest Rollback(RollbackApiSpecRequest body, string name)

Parameters

Type	Name	Description
RollbackApiSpecRequest	body	The body of the request.
string	name	Required. The spec being rolled back.

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.RollbackRequest

SetIamPolicy(SetIamPolicyRequest, 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.VersionsResource.SpecsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	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.VersionsResource.SpecsResource.SetIamPolicyRequest

TagRevision(TagApiSpecRevisionRequest, string)

Adds a tag to a specified revision of a spec.

Declaration

public virtual ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.TagRevisionRequest TagRevision(TagApiSpecRevisionRequest body, string name)

Parameters

Type	Name	Description
TagApiSpecRevisionRequest	body	The body of the request.
string	name	Required. The name of the spec to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.

Returns

Type	Description
ProjectsResource.LocationsResource.ApisResource.VersionsResource.SpecsResource.TagRevisionRequest

TestIamPermissions(TestIamPermissionsRequest, 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.VersionsResource.SpecsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	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.VersionsResource.SpecsResource.TestIamPermissionsRequest