Google Cloud Key Management Service v1 API - Class ListKeyRingsRequest (3.4.0)

public sealed class ListKeyRingsRequest : IPageRequest, IMessage<ListKeyRingsRequest>, IEquatable<ListKeyRingsRequest>, IDeepCloneable<ListKeyRingsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class ListKeyRingsRequest.

Request message for [KeyManagementService.ListKeyRings][google.cloud.kms.v1.KeyManagementService.ListKeyRings].

Inheritance

object > ListKeyRingsRequest

Implements

IPageRequest, IMessage ListKeyRingsRequest, IEquatable ListKeyRingsRequest, IDeepCloneable ListKeyRingsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.KmsV1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

ListKeyRingsRequest()

public ListKeyRingsRequest()

ListKeyRingsRequest(ListKeyRingsRequest)

public ListKeyRingsRequest(ListKeyRingsRequest other)

Parameter
Name	Description
`other`	`ListKeyRingsRequest`

Properties

Filter

public string Filter { get; set; }

Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.

Property Value
Type	Description
`string`

OrderBy

public string OrderBy { get; set; }

Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

Property Value
Type	Description
`string`

PageSize

public int PageSize { get; set; }

Optional. Optional limit on the number of [KeyRings][google.cloud.kms.v1.KeyRing] to include in the response. Further [KeyRings][google.cloud.kms.v1.KeyRing] can subsequently be obtained by including the [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token] in a subsequent request. If unspecified, the server will pick an appropriate default.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

Optional. Optional pagination token, returned earlier via [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token].

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

Required. The resource name of the location associated with the [KeyRings][google.cloud.kms.v1.KeyRing], in the format projects/*/locations/*.

Property Value
Type	Description
`string`

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type	Description
`LocationName`