FormatSchemaService

Call Description
Get
List
Create
Update
Delete

Calls FormatSchemaService

Get

rpc Get (GetFormatSchemaRequest) returns (FormatSchema)

GetFormatSchemaRequest

Field Description
cluster_id string
Required. The maximum string length in characters is 50.
format_schema_name string
Required. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

FormatSchema

Field Description
name string
cluster_id string
type enum FormatSchemaType
    uri string

    List

    rpc List (ListFormatSchemasRequest) returns (ListFormatSchemasResponse)

    ListFormatSchemasRequest

    Field Description
    cluster_id string
    Required. The maximum string length in characters is 50.
    page_size int64
    The maximum value is 1000.
    page_token string
    The maximum string length in characters is 100.

    ListFormatSchemasResponse

    Field Description
    format_schemas[] FormatSchema
    next_page_token string

    FormatSchema

    Field Description
    name string
    cluster_id string
    type enum FormatSchemaType
      uri string

      Create

      rpc Create (CreateFormatSchemaRequest) returns (operation.Operation)

      Metadata and response of Operation:
          Operation.metadata:CreateFormatSchemaMetadata
          Operation.response:FormatSchema

      CreateFormatSchemaRequest

      Field Description
      cluster_id string
      Required. The maximum string length in characters is 50.
      format_schema_name string
      Required. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
      type enum FormatSchemaType
      Required.
        uri string
        Required.

        Operation

        Field Description
        id string
        ID of the operation.
        description string
        Description of the operation. 0-256 characters long.
        created_at google.protobuf.Timestamp
        Creation timestamp.
        created_by string
        ID of the user or service account who initiated the operation.
        modified_at google.protobuf.Timestamp
        The time when the Operation resource was last modified.
        done bool
        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
        metadata google.protobuf.Any<CreateFormatSchemaMetadata>
        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
        result oneof: error or response
        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
          error google.rpc.Status
        The error result of the operation in case of failure or cancellation.
          response google.protobuf.Any<FormatSchema>
        if operation finished successfully.

        CreateFormatSchemaMetadata

        Field Description
        cluster_id string
        format_schema_name string

        FormatSchema

        Field Description
        name string
        cluster_id string
        type enum FormatSchemaType
          uri string

          Update

          rpc Update (UpdateFormatSchemaRequest) returns (operation.Operation)

          Metadata and response of Operation:
              Operation.metadata:UpdateFormatSchemaMetadata
              Operation.response:FormatSchema

          UpdateFormatSchemaRequest

          Field Description
          cluster_id string
          Required. The maximum string length in characters is 50.
          format_schema_name string
          Required. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
          update_mask google.protobuf.FieldMask
          uri string

          Operation

          Field Description
          id string
          ID of the operation.
          description string
          Description of the operation. 0-256 characters long.
          created_at google.protobuf.Timestamp
          Creation timestamp.
          created_by string
          ID of the user or service account who initiated the operation.
          modified_at google.protobuf.Timestamp
          The time when the Operation resource was last modified.
          done bool
          If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
          metadata google.protobuf.Any<UpdateFormatSchemaMetadata>
          Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
          result oneof: error or response
          The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
            error google.rpc.Status
          The error result of the operation in case of failure or cancellation.
            response google.protobuf.Any<FormatSchema>
          if operation finished successfully.

          UpdateFormatSchemaMetadata

          Field Description
          cluster_id string
          format_schema_name string

          FormatSchema

          Field Description
          name string
          cluster_id string
          type enum FormatSchemaType
            uri string

            Delete

            rpc Delete (DeleteFormatSchemaRequest) returns (operation.Operation)

            Metadata and response of Operation:
                Operation.metadata:DeleteFormatSchemaMetadata
                Operation.response:google.protobuf.Empty

            DeleteFormatSchemaRequest

            Field Description
            cluster_id string
            Required. The maximum string length in characters is 50.
            format_schema_name string
            Required. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

            Operation

            Field Description
            id string
            ID of the operation.
            description string
            Description of the operation. 0-256 characters long.
            created_at google.protobuf.Timestamp
            Creation timestamp.
            created_by string
            ID of the user or service account who initiated the operation.
            modified_at google.protobuf.Timestamp
            The time when the Operation resource was last modified.
            done bool
            If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
            metadata google.protobuf.Any<DeleteFormatSchemaMetadata>
            Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
            result oneof: error or response
            The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
              error google.rpc.Status
            The error result of the operation in case of failure or cancellation.
              response google.protobuf.Any<google.protobuf.Empty>
            if operation finished successfully.

            DeleteFormatSchemaMetadata

            Field Description
            cluster_id string
            format_schema_name string