Skip to main content

Package animeshon.crossrefs.v1alpha1

Index​

Referrer​

GetCrossRef
rpc GetCrossRef(GetCrossRefRequest) CrossRef

GetCrossRef returns a crossref.
ListCrossRefs
rpc ListCrossRefs(ListCrossRefsRequest) ListCrossRefsResponse

CreateCrossRef
rpc CreateCrossRef(CreateCrossRefRequest) CrossRef

CreateCrossRef creates a new crossref.
BatchCreateCrossRefs
rpc BatchCreateCrossRefs(BatchCreateCrossRefsRequest) BatchCreateCrossRefsResponse

BatchCreateCrossRefs creates new crossrefs in batch. The limit is of 10 crossreferences and it's blocking. It ensures that the crossreferences are created in the database but not propagated to the other services
UpdateCrossRef
rpc UpdateCrossRef(UpdateCrossRefRequest) UpdateCrossRefResponse

CountCrossRefs
rpc CountCrossRefs(CountCrossRefsRequest) CountCrossRefsResponse

AnalyzeCrossRefs
rpc AnalyzeCrossRefs(AnalyzeCrossRefRequest) .google.longrunning.Operation

Analyzes and proposes new cross-references according to their similarity.
ImportCrossRefs
rpc ImportCrossRefs(ImportCrossRefRequest) .google.longrunning.Operation

Imports already existing cross-references from third-parties.
ExportCrossRefs
rpc ExportCrossRefs(ExportCrossRefRequest) .google.longrunning.Operation

Exports the cross-references to Cloud Pub/Sub for a full synchronization. This operation is usually called after a new import with a clean database.
InitializeCrossRefs
rpc InitializeCrossRefs(.google.protobuf.Empty) .google.longrunning.Operation

Initialize the cross-references using specific namespaces for each kind. This operation first analyzes the entities meeting the kind and namespace precondition to match new entities with existing ones
AnalyzeParodies
rpc AnalyzeParodies(.google.protobuf.Empty) .google.longrunning.Operation

ExportParodies
rpc ExportParodies(.google.protobuf.Empty) .google.longrunning.Operation

GetUniverse
rpc GetUniverse(GetUniverseRequest) Universe

UpdateUniverse
rpc UpdateUniverse(UpdateUniverseRequest) Universe

ExpandUniverse
rpc ExpandUniverse(ExpandUniverseRequest) ExpandUniverseResponse

GetWormhole
rpc GetWormhole(GetWormholeRequest) Wormhole

ListWormholeCrossRefs
rpc ListWormholeCrossRefs(ListWormholeCrossRefsRequest) ListWormholeCrossRefsResponse

AnalyzeCrossRefRequest​

FieldDescription
config AnalyzeCrossRefRequest.AnalyzeCrossRefConfig
Global configuration
target_kindsmap AnalyzeCrossRefRequest.TargetKindsEntry
Kind configurations

AnalyzeCrossRefRequest.AnalyzeCrossRefConfig​

FieldDescription
tollerance int32
Tollerance of the match in pct
optsmap AnalyzeCrossRefRequest.AnalyzeCrossRefConfig.OptsEntry
Map of all options for the analysis

AnalyzeCrossRefRequest.AnalyzeCrossRefConfig.OptsEntry​

FieldDescription
key string
value bool

AnalyzeCrossRefRequest.AnalyzeCrossRefNamespaceConfig​

FieldDescription
namespace string
Namespace to analyze
config AnalyzeCrossRefRequest.AnalyzeCrossRefConfig
Optional Namespace specific configuration

AnalyzeCrossRefRequest.AnalyzeCrossRefTargetConfig​

FieldDescription
target_kind string
Kind to analyze
config AnalyzeCrossRefRequest.AnalyzeCrossRefConfig
Optional Target specific configuration
namespacesmap AnalyzeCrossRefRequest.AnalyzeCrossRefTargetConfig.NamespacesEntry
Namespace configurations

AnalyzeCrossRefRequest.AnalyzeCrossRefTargetConfig.NamespacesEntry​

FieldDescription
key string
value AnalyzeCrossRefRequest.AnalyzeCrossRefNamespaceConfig

AnalyzeCrossRefRequest.TargetKindsEntry​

FieldDescription
key string
value AnalyzeCrossRefRequest.AnalyzeCrossRefTargetConfig

AnalyzeCrossRefsResponse​

TODO(christian-roggia): this is a workaround to solve the issue of GAPIC CLI where broken code is generated if google.protobuf.Empty is used in the response_type of longrunning operations.

AnalyzeParodiesResponse​

BatchCreateCrossRefsRequest​

FieldDescription
crossrefsrepeated CrossRef

BatchCreateCrossRefsResponse​

FieldDescription
crossrefsrepeated CrossRef
The list of crossrefs to create.

CountCrossRefsRequest​

FieldDescription
filter CrossRefsFilterRequest
A filter to be applied to results.

CountCrossRefsResponse​

FieldDescription
count int32

CreateCrossRefRequest​

FieldDescription
crossref CrossRef

CrossRef​

FieldDescription
name string
The resource name of the crossref.
root string
root entity which generated the crossreference.
etag string
version control.
verified bool
if verified, the crossreference has been generated by a trusty process or verified by an operator
operator string
last operator which edited the crossreference
create_time google.protobuf.Timestamp
creation time
update_time google.protobuf.Timestamp
update time
edgesrepeated CrossRefEdge
all edges of the crossreference

CrossRefEdge​

FieldDescription
name string
state int32

CrossRefsFilterRequest​

FieldDescription
prefix string
specifies the prefix of the CrossRefs name to search in
pendingOnly bool
if true only crossreferences with pendings are returned

ExpandUniverseRequest​

FieldDescription
name string
The universe to expand.
depth_limit int32
The maximum depth to expand.
filter string
The filter to use. Accepted values are CONTENT and CHARACTER.

ExpandUniverseResponse​

FieldDescription
name string
The resource name of the requested universe.
payload bytes
TODO(christian-roggia): resources should be available through protobuf messages.

ExportCrossRefRequest​

FieldDescription
target ExportCrossRefRequest.Target
prefix string
Prefix to restrict the crossrefs to export to a specific subset

ExportCrossRefsResponse​

ExportParodiesResponse​

GetCrossRefRequest​

FieldDescription
name string
The resource name of the requested crossref.

GetUniverseRequest​

FieldDescription
name string
The resource name of the requested universe.

GetWormholeRequest​

FieldDescription
name string

ImportCrossRefRequest​

FieldDescription
optsmap ImportCrossRefRequest.OptsEntry
Map of all options for the import

ImportCrossRefRequest.OptsEntry​

FieldDescription
key string
value bool

ImportCrossRefsResponse​

InitializeCrossRefsResponse​

ListCrossRefsRequest​

FieldDescription
page_size int32
The maximum number of users to return. Server may return fewer users than requested. The maximum page_size is 100 If unspecified, server will pick an appropriate default.
page_token string
The value returned from the previous call.
filter CrossRefsFilterRequest
A filter to be applied to results.

ListCrossRefsResponse​

FieldDescription
crossrefsrepeated CrossRef
The list of crossrefs.
next_page_token string
A token to retrieve next page of results.

ListWormholeCrossRefsRequest​

FieldDescription
name string
withApproved bool
search wormhole entity in approved edges
withPending bool
search wormhole entity in pending edges
withPartial bool
search wormhole entity in partial edges
withRejected bool
search wormhole entity in rejected edges
crossRefsExclusionrepeated string
list of CrossRefs to exclude
prefix string
prefix of the CrossRefs name to search

ListWormholeCrossRefsResponse​

FieldDescription
crossrefsrepeated CrossRef
The list of crossrefs.

OperationMetadata​

Represents the metadata of the long-running operation.

FieldDescription
create_time google.protobuf.Timestamp
Output only. The time the operation was created.
end_time google.protobuf.Timestamp
Output only. The time the operation finished running.
target string
Output only. Server-defined resource path for the target of the operation.
verb string
Output only. Name of the verb executed by the operation.
status_message string
Output only. Human-readable status of the operation, if any.
requested_cancellation bool
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.
api_version string
Output only. API version used to start the operation.
step_count int32
Output only.
step_progress int32
Output only.
item_count int32
Output only.
item_progress int32
Output only.

Universe​

TODO(christian-roggia): move the universe together with all other resources.

FieldDescription
name string
The resource name of the universe.
payload bytes
TODO(christian-roggia): resources should be available through protobuf messages.

UpdateCrossRefRequest​

FieldDescription
crossref CrossRef
The crossref to update.
update_mask google.protobuf.FieldMask
The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.

UpdateCrossRefResponse​

FieldDescription
crossrefsrepeated CrossRef
All CrossRef involved in the update

UpdateUniverseRequest​

FieldDescription
universe Universe
The universe to update.
update_mask google.protobuf.FieldMask
The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.

Wormhole​

FieldDescription
name string
namesrepeated Wormhole.Text
The names of te content
aliasesrepeated Wormhole.Text
The aliases of te content
image bytes
raw bytes of image
image_url string
url of the image
type string
type of the content
subtype string
subtype of the content
external_url string
external url of the content
publishing_type string
type of publication
is_parody bool
the content is parody of another content
identifier string
identifier
date google.protobuf.Timestamp
most significant date
parent_name string
parent's resource name useful for chapters and episodes to know which content it refers
parent_external_url string
prant external url

Wormhole.Text​

FieldDescription
text string
localization string

ExportCrossRefRequest.Target​

Determine the target of the export. Full means storage + migration Storage means only persinstent stogare Migration means notify the migrato to perform the data consolidation

NameDescription
FULLNo description.
STORAGENo description.
MIGRATORNo description.