ListKeyRingsRequest

com.google.cloud.kms.v1.service.ListKeyRingsRequest
See theListKeyRingsRequest companion object
final case class ListKeyRingsRequest(parent: String, pageSize: Int, pageToken: String, filter: String, orderBy: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListKeyRingsRequest]

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

Value parameters

filter

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

orderBy

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.

pageSize

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.

pageToken

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

parent

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

Attributes

Companion
object
Source
ListKeyRingsRequest.scala
Graph
Supertypes
trait Updatable[ListKeyRingsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
ListKeyRingsRequest.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
ListKeyRingsRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
ListKeyRingsRequest.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
ListKeyRingsRequest.scala
def withFilter(`__v`: String): ListKeyRingsRequest

Attributes

Source
ListKeyRingsRequest.scala
def withOrderBy(`__v`: String): ListKeyRingsRequest

Attributes

Source
ListKeyRingsRequest.scala

Attributes

Source
ListKeyRingsRequest.scala
def withPageToken(`__v`: String): ListKeyRingsRequest

Attributes

Source
ListKeyRingsRequest.scala
def withParent(`__v`: String): ListKeyRingsRequest

Attributes

Source
ListKeyRingsRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): ListKeyRingsRequest

Attributes

Source
ListKeyRingsRequest.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
ListKeyRingsRequest.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala