Show / Hide Table of Contents

Namespace Google.Apis.Contentwarehouse.v1.Data

Classes

CloudAiPlatformTenantresourceCloudSqlInstanceConfig

The identity to configure a CloudSQL instance provisioned via SLM Terraform.

CloudAiPlatformTenantresourceGcsBucketConfig

The identity to configure a GCS bucket.

CloudAiPlatformTenantresourceIamPolicyBinding

The dynamic IAM bindings to be granted after tenant projects are created.

CloudAiPlatformTenantresourceInfraSpannerConfig

The configuration for a spanner database provisioning. Next ID: 8

CloudAiPlatformTenantresourceInfraSpannerConfigCreateDatabaseOptions

The options to create a spanner database. KMS key access audit logging and AxT logging will be associated with the given resource name, resource type and service name. Please ensure to give right options to enable correct audit logging and AxT logging.

CloudAiPlatformTenantresourceServiceAccountIdentity

The identity to configure a service account.

CloudAiPlatformTenantresourceTenantProjectConfig

The identity to configure a tenant project.

CloudAiPlatformTenantresourceTenantProjectResource

The tenant project and tenant resources. Next ID: 10

CloudAiPlatformTenantresourceTenantResource

A collection of tenant resources.

CloudAiPlatformTenantresourceTenantServiceAccountIdentity

The identity of service accounts that have been explicitly created under tenant projects.

GoogleApiServiceconsumermanagementV1BillingConfig

Describes the billing configuration for a new tenant project.

GoogleApiServiceconsumermanagementV1PolicyBinding

Translates to IAM Policy bindings (without auditing at this level)

GoogleCloudContentwarehouseV1AccessControlAction

Represents the action responsible for access control list management operations.

GoogleCloudContentwarehouseV1Action

Represents the action triggered by Rule Engine when the rule is true.

GoogleCloudContentwarehouseV1ActionExecutorOutput

Represents the output of the Action Executor.

GoogleCloudContentwarehouseV1ActionOutput

Represents the result of executing an action.

GoogleCloudContentwarehouseV1AddToFolderAction

Represents the action responsible for adding document under a folder.

GoogleCloudContentwarehouseV1CloudAIDocumentOption

Request Option for processing Cloud AI Document in CW Document.

GoogleCloudContentwarehouseV1CreateDocumentLinkRequest

Request message for DocumentLinkService.CreateDocumentLink.

GoogleCloudContentwarehouseV1CreateDocumentMetadata

Metadata object for CreateDocument request (currently empty).

GoogleCloudContentwarehouseV1CreateDocumentRequest

Request message for DocumentService.CreateDocument.

GoogleCloudContentwarehouseV1CreateDocumentResponse

Response message for DocumentService.CreateDocument.

GoogleCloudContentwarehouseV1CustomWeightsMetadata

To support the custom weighting across document schemas.

GoogleCloudContentwarehouseV1DataUpdateAction

Represents the action responsible for properties update operations.

GoogleCloudContentwarehouseV1DataValidationAction

Represents the action responsible for data validation operations.

GoogleCloudContentwarehouseV1DateTimeArray

DateTime values.

GoogleCloudContentwarehouseV1DateTimeTypeOptions

Configurations for a date time property.

GoogleCloudContentwarehouseV1DeleteDocumentAction

Represents the action responsible for deleting the document.

GoogleCloudContentwarehouseV1DeleteDocumentLinkRequest

Request message for DocumentLinkService.DeleteDocumentLink.

GoogleCloudContentwarehouseV1DeleteDocumentRequest

Request message for DocumentService.DeleteDocument.

GoogleCloudContentwarehouseV1Document

Defines the structure for content warehouse document proto.

GoogleCloudContentwarehouseV1DocumentLink

A document-link between source and target document.

GoogleCloudContentwarehouseV1DocumentQuery

GoogleCloudContentwarehouseV1DocumentReference

References to the documents.

GoogleCloudContentwarehouseV1DocumentSchema

A document schema used to define document structure.

GoogleCloudContentwarehouseV1EnumArray

Enum values.

GoogleCloudContentwarehouseV1EnumTypeOptions

Configurations for an enum/categorical property.

GoogleCloudContentwarehouseV1EnumValue

Represents the string value of the enum field.

GoogleCloudContentwarehouseV1ExportToCdwPipeline

The configuration of exporting documents from the Document Warehouse to CDW pipeline.

GoogleCloudContentwarehouseV1FetchAclRequest

Request message for DocumentService.FetchAcl

GoogleCloudContentwarehouseV1FetchAclResponse

Response message for DocumentService.FetchAcl.

GoogleCloudContentwarehouseV1FileTypeFilter

Filter for the specific types of documents returned.

GoogleCloudContentwarehouseV1FloatArray

Float values.

GoogleCloudContentwarehouseV1FloatTypeOptions

Configurations for a float property.

GoogleCloudContentwarehouseV1GcsIngestPipeline

The configuration of the Cloud Storage Ingestion pipeline.

GoogleCloudContentwarehouseV1GcsIngestWithDocAiProcessorsPipeline

The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline.

GoogleCloudContentwarehouseV1GetDocumentRequest

Request message for DocumentService.GetDocument.

GoogleCloudContentwarehouseV1HistogramQuery

The histogram request.

GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter

GoogleCloudContentwarehouseV1HistogramQueryResult

Histogram result that matches HistogramQuery specified in searches.

GoogleCloudContentwarehouseV1IngestPipelineConfig

The ingestion pipeline config.

GoogleCloudContentwarehouseV1InitializeProjectRequest

Request message for projectService.InitializeProject

GoogleCloudContentwarehouseV1InitializeProjectResponse

Response message for projectService.InitializeProject

GoogleCloudContentwarehouseV1IntegerArray

Integer values.

GoogleCloudContentwarehouseV1IntegerTypeOptions

Configurations for an integer property.

GoogleCloudContentwarehouseV1InvalidRule

A triggered rule that failed the validation check(s) after parsing.

GoogleCloudContentwarehouseV1ListDocumentSchemasResponse

Response message for DocumentSchemaService.ListDocumentSchemas.

GoogleCloudContentwarehouseV1ListLinkedSourcesRequest

Response message for DocumentLinkService.ListLinkedSources.

GoogleCloudContentwarehouseV1ListLinkedSourcesResponse

Response message for DocumentLinkService.ListLinkedSources.

GoogleCloudContentwarehouseV1ListLinkedTargetsRequest

Request message for DocumentLinkService.ListLinkedTargets.

GoogleCloudContentwarehouseV1ListLinkedTargetsResponse

Response message for DocumentLinkService.ListLinkedTargets.

GoogleCloudContentwarehouseV1ListRuleSetsResponse

Response message for RuleSetService.ListRuleSets.

GoogleCloudContentwarehouseV1ListSynonymSetsResponse

Response message for SynonymSetService.ListSynonymSets.

GoogleCloudContentwarehouseV1LockDocumentRequest

Request message for DocumentService.LockDocument.

GoogleCloudContentwarehouseV1MapProperty

Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values.

GoogleCloudContentwarehouseV1MapTypeOptions

Configurations for a Map property.

GoogleCloudContentwarehouseV1MergeFieldsOptions

Options for merging updated fields.

GoogleCloudContentwarehouseV1ProcessWithDocAiPipeline

The configuration of processing documents in Document Warehouse with DocAi processors pipeline.

GoogleCloudContentwarehouseV1ProcessorInfo

The DocAI processor information.

GoogleCloudContentwarehouseV1ProjectStatus

Status of a project, including the project state, dbType, aclMode and etc.

GoogleCloudContentwarehouseV1Property

Property of a document.

GoogleCloudContentwarehouseV1PropertyArray

Property values.

GoogleCloudContentwarehouseV1PropertyDefinition

Defines the metadata for a schema property.

GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource

The schema source information.

GoogleCloudContentwarehouseV1PropertyFilter

GoogleCloudContentwarehouseV1PropertyTypeOptions

Configurations for a nested structured data property.

GoogleCloudContentwarehouseV1PublishAction

Represents the action responsible for publishing messages to a Pub/Sub topic.

GoogleCloudContentwarehouseV1QAResult

Additional result info for the question-answering feature.

GoogleCloudContentwarehouseV1QAResultHighlight

A text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.).

GoogleCloudContentwarehouseV1RemoveFromFolderAction

Represents the action responsible for remove a document from a specific folder.

GoogleCloudContentwarehouseV1RequestMetadata

Meta information is used to improve the performance of the service.

GoogleCloudContentwarehouseV1ResponseMetadata

Additional information returned to client, such as debugging information.

GoogleCloudContentwarehouseV1Rule

Represents the rule for a content warehouse trigger.

GoogleCloudContentwarehouseV1RuleActionsPair

Represents a rule and outputs of associated actions.

GoogleCloudContentwarehouseV1RuleEngineOutput

Records the output of Rule Engine including rule evaluation and actions result.

GoogleCloudContentwarehouseV1RuleEvaluatorOutput

Represents the output of the Rule Evaluator.

GoogleCloudContentwarehouseV1RuleSet

Represents a set of rules from a single customer.

GoogleCloudContentwarehouseV1RunPipelineMetadata

Metadata message of RunPipeline method.

GoogleCloudContentwarehouseV1RunPipelineMetadataExportToCdwPipelineMetadata

The metadata message for Export-to-CDW pipeline.

GoogleCloudContentwarehouseV1RunPipelineMetadataGcsIngestPipelineMetadata

The metadata message for GcsIngest pipeline.

GoogleCloudContentwarehouseV1RunPipelineMetadataIndividualDocumentStatus

The status of processing a document.

GoogleCloudContentwarehouseV1RunPipelineMetadataProcessWithDocAiPipelineMetadata

The metadata message for Process-with-DocAi pipeline.

GoogleCloudContentwarehouseV1RunPipelineRequest

Request message for DocumentService.RunPipeline.

GoogleCloudContentwarehouseV1SearchDocumentsRequest

Request message for DocumentService.SearchDocuments.

GoogleCloudContentwarehouseV1SearchDocumentsResponse

Response message for DocumentService.SearchDocuments.

GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument

Document entry with metadata inside SearchDocumentsResponse

GoogleCloudContentwarehouseV1SetAclRequest

Request message for DocumentService.SetAcl.

GoogleCloudContentwarehouseV1SetAclResponse

Response message for DocumentService.SetAcl.

GoogleCloudContentwarehouseV1SynonymSet

Represents a list of synonyms for a given context. For example a context "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint

GoogleCloudContentwarehouseV1SynonymSetSynonym

Represents a list of words given by the customer All these words are synonyms of each other.

GoogleCloudContentwarehouseV1TextArray

String/text values.

GoogleCloudContentwarehouseV1TextTypeOptions

Configurations for a text property.

GoogleCloudContentwarehouseV1TimeFilter

Filter on create timestamp or update timestamp of documents.

GoogleCloudContentwarehouseV1TimestampArray

Timestamp values.

GoogleCloudContentwarehouseV1TimestampTypeOptions

Configurations for a timestamp property.

GoogleCloudContentwarehouseV1TimestampValue

Timestamp value type.

GoogleCloudContentwarehouseV1UpdateDocumentMetadata

Metadata object for UpdateDocument request (currently empty).

GoogleCloudContentwarehouseV1UpdateDocumentRequest

Request message for DocumentService.UpdateDocument.

GoogleCloudContentwarehouseV1UpdateDocumentResponse

Response message for DocumentService.UpdateDocument.

GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest

Request message for DocumentSchemaService.UpdateDocumentSchema.

GoogleCloudContentwarehouseV1UpdateOptions

Options for Update operations.

GoogleCloudContentwarehouseV1UpdateRuleSetRequest

Request message for RuleSetService.UpdateRuleSet.

GoogleCloudContentwarehouseV1UserInfo

The user information.

GoogleCloudContentwarehouseV1Value

Value represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

GoogleCloudContentwarehouseV1WeightedSchemaProperty

Specifies the schema property name.

GoogleCloudContentwarehouseV1beta1CreateDocumentMetadata

Metadata object for CreateDocument request (currently empty).

GoogleCloudContentwarehouseV1beta1InitializeProjectResponse

Response message for projectService.InitializeProject

GoogleCloudContentwarehouseV1beta1UpdateDocumentMetadata

Metadata object for UpdateDocument request (currently empty).

GoogleCloudDocumentaiV1Barcode

Encodes the detailed information of a barcode.

GoogleCloudDocumentaiV1BoundingPoly

A bounding polygon for the detected image annotation.

GoogleCloudDocumentaiV1Document

Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.

GoogleCloudDocumentaiV1DocumentChunkedDocument

Represents the chunks that the document is divided into.

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk

Represents a chunk.

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter

Represents the page footer associated with the chunk.

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader

Represents the page header associated with the chunk.

GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan

Represents where the chunk starts and ends in the document.

GoogleCloudDocumentaiV1DocumentDocumentLayout

Represents the parsed layout of a document as a collection of blocks that the document is divided into.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock

Represents a block. A block could be one of the various types (text, table, list) supported.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock

Represents a list type block.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry

Represents an entry in the list.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan

Represents where the block starts and ends in the document.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock

Represents a table type block.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell

Represents a cell in a table row.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow

Represents a row in a table.

GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock

Represents a text type block.

GoogleCloudDocumentaiV1DocumentEntity

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.

GoogleCloudDocumentaiV1DocumentEntityNormalizedValue

Parsed and normalized entity value.

GoogleCloudDocumentaiV1DocumentEntityRelation

Relationship between Entities.

GoogleCloudDocumentaiV1DocumentPage

A page in a Document.

GoogleCloudDocumentaiV1DocumentPageAnchor

Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.

GoogleCloudDocumentaiV1DocumentPageAnchorPageRef

Represents a weak reference to a page element within a document.

GoogleCloudDocumentaiV1DocumentPageBlock

A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.

GoogleCloudDocumentaiV1DocumentPageDetectedBarcode

A detected barcode.

GoogleCloudDocumentaiV1DocumentPageDetectedLanguage

Detected language for a structural component.

GoogleCloudDocumentaiV1DocumentPageDimension

Dimension for the page.

GoogleCloudDocumentaiV1DocumentPageFormField

A form field detected on the page.

GoogleCloudDocumentaiV1DocumentPageImage

Rendered image contents for this page.

GoogleCloudDocumentaiV1DocumentPageImageQualityScores

Image quality scores for the page image.

GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect

Image Quality Defects

GoogleCloudDocumentaiV1DocumentPageLayout

Visual element describing a layout unit on a page.

GoogleCloudDocumentaiV1DocumentPageLine

A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.

GoogleCloudDocumentaiV1DocumentPageMatrix

Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.

GoogleCloudDocumentaiV1DocumentPageParagraph

A collection of lines that a human would perceive as a paragraph.

GoogleCloudDocumentaiV1DocumentPageSymbol

A detected symbol.

GoogleCloudDocumentaiV1DocumentPageTable

A table representation similar to HTML table structure.

GoogleCloudDocumentaiV1DocumentPageTableTableCell

A cell representation inside the table.

GoogleCloudDocumentaiV1DocumentPageTableTableRow

A row of table cells.

GoogleCloudDocumentaiV1DocumentPageToken

A detected token.

GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak

Detected break at the end of a Token.

GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo

Font and other text style attributes.

GoogleCloudDocumentaiV1DocumentPageVisualElement

Detected non-text visual elements e.g. checkbox, signature etc. on the page.

GoogleCloudDocumentaiV1DocumentProvenance

Structure to identify provenance relationships between annotations in different revisions.

GoogleCloudDocumentaiV1DocumentProvenanceParent

The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.

GoogleCloudDocumentaiV1DocumentRevision

Contains past or forward revisions of this document.

GoogleCloudDocumentaiV1DocumentRevisionHumanReview

Human Review information of the document.

GoogleCloudDocumentaiV1DocumentShardInfo

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.

GoogleCloudDocumentaiV1DocumentStyle

Annotation for common text style attributes. This adheres to CSS conventions as much as possible.

GoogleCloudDocumentaiV1DocumentStyleFontSize

Font size with unit.

GoogleCloudDocumentaiV1DocumentTextAnchor

Text reference indexing into the Document.text.

GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment

A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset

GoogleCloudDocumentaiV1DocumentTextChange

This message is used for text changes aka. OCR corrections.

GoogleCloudDocumentaiV1NormalizedVertex

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

GoogleCloudDocumentaiV1Vertex

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

GoogleIamV1AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

GoogleIamV1AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

GoogleIamV1Binding

Associates members, or principals, with a role.

GoogleIamV1Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example:

{
"bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com",
"group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] },
{ "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": {
"title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time
< timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

YAML example:

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com -
serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin -
members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable
access description: Does not grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the IAM documentation.

GoogleLongrunningOperation

This resource represents a long-running operation that is the result of a network API call.

GoogleProtobufEmpty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

GoogleTypeColor

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of java.awt.Color in Java; it can also be trivially provided to UIColor's +colorWithRed:green:blue:alpha method in iOS; and, with just a little work, it can be easily formatted into a CSS rgba() string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...

GoogleTypeDate

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

GoogleTypeDateTime

Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset oneof is set. Consider using Timestamp message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

GoogleTypeExpr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

GoogleTypeInterval

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

GoogleTypeMoney

Represents an amount of money with its currency type.

GoogleTypePostalAddress

Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478

GoogleTypeTimeZone

Represents a time zone from the IANA Time Zone Database.

In this article
Back to top Generated by DocFX